From fecb928761e61b399f6a1b8922f543afead5bc7f Mon Sep 17 00:00:00 2001 From: Nandan Bhat Date: Fri, 17 Apr 2026 18:21:48 +0530 Subject: [PATCH] Release v4.18.0 --- .version | 2 +- CHANGELOG.md | 9 +++ docs/assets/hierarchy.js | 2 +- docs/assets/main.js | 2 +- docs/assets/search.js | 2 +- docs/classes/errors.AccessTokenError.html | 4 +- .../errors.AccessTokenForConnectionError.html | 8 +-- .../errors.AuthorizationCodeGrantError.html | 4 +- ...rs.AuthorizationCodeGrantRequestError.html | 4 +- docs/classes/errors.AuthorizationError.html | 4 +- ...errors.BackchannelAuthenticationError.html | 4 +- ...hannelAuthenticationNotSupportedError.html | 4 +- .../errors.BackchannelLogoutError.html | 6 +- docs/classes/errors.ConnectAccountError.html | 8 +-- .../errors.CustomTokenExchangeError.html | 10 +-- docs/classes/errors.DPoPError.html | 10 +-- docs/classes/errors.DiscoveryError.html | 4 +- .../errors.InvalidConfigurationError.html | 4 +- docs/classes/errors.InvalidRequestError.html | 6 +- docs/classes/errors.InvalidStateError.html | 4 +- docs/classes/errors.MfaChallengeError.html | 8 +-- docs/classes/errors.MfaEnrollmentError.html | 8 +-- .../errors.MfaGetAuthenticatorsError.html | 8 +-- .../errors.MfaNoAvailableFactorsError.html | 6 +- docs/classes/errors.MfaVerifyError.html | 8 +-- docs/classes/errors.MissingStateError.html | 4 +- docs/classes/errors.MyAccountApiError.html | 8 +-- docs/classes/errors.OAuth2Error.html | 6 +- docs/classes/errors.SdkError.html | 4 +- docs/classes/server.AbstractSessionStore.html | 12 ++-- docs/classes/server.Auth0Client.html | 32 +++++----- .../classes/server.DomainResolutionError.html | 8 +-- .../classes/server.DomainValidationError.html | 6 +- .../classes/server.IssuerValidationError.html | 10 +-- docs/classes/server.MfaRequiredError.html | 16 ++--- docs/classes/server.MfaTokenExpiredError.html | 6 +- docs/classes/server.MfaTokenInvalidError.html | 6 +- .../server.SessionDomainMismatchError.html | 6 +- docs/classes/server.TransactionStore.html | 12 ++-- docs/enums/errors.AccessTokenErrorCode.html | 4 +- ...ors.AccessTokenForConnectionErrorCode.html | 10 +-- .../errors.ConnectAccountErrorCodes.html | 10 +-- .../errors.CustomTokenExchangeErrorCode.html | 12 ++-- docs/enums/errors.DPoPErrorCode.html | 10 +-- docs/enums/types.RESPONSE_TYPES.html | 6 +- docs/enums/types.SUBJECT_TOKEN_TYPES.html | 6 +- docs/functions/client.Auth0Provider.html | 2 +- docs/functions/client.getAccessToken.html | 6 +- docs/functions/client.useUser.html | 2 +- .../server.filterDefaultIdTokenClaims.html | 4 +- .../functions/server.generateDpopKeyPair.html | 4 +- .../testing.generateSessionCookie.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 4 +- .../client.WithPageAuthRequiredOptions.html | 10 +-- .../errors.MfaApiErrorResponse.html | 6 +- docs/interfaces/server.MfaRequirements.html | 8 +-- ...types.AccessTokenForConnectionOptions.html | 10 +-- docs/interfaces/types.AccessTokenSet.html | 4 +- docs/interfaces/types.Auth0ClientOptions.html | 62 +++++++++---------- docs/interfaces/types.Authenticator.html | 22 +++---- .../types.AuthorizationDetails.html | 4 +- .../types.AuthorizationParameters.html | 14 ++--- ...ypes.BackchannelAuthenticationOptions.html | 12 ++-- ...pes.BackchannelAuthenticationResponse.html | 4 +- docs/interfaces/types.ChallengeResponse.html | 10 +-- .../types.ConnectAccountOptions.html | 12 ++-- docs/interfaces/types.ConnectionTokenSet.html | 4 +- docs/interfaces/types.CookieOptions.html | 4 +- .../types.CustomTokenExchangeOptions.html | 20 +++--- .../types.CustomTokenExchangeResponse.html | 16 ++--- .../types.DiscoveryCacheOptions.html | 8 +-- docs/interfaces/types.EnrollOobOptions.html | 14 ++--- docs/interfaces/types.EnrollOtpOptions.html | 8 +-- docs/interfaces/types.MCDMetadata.html | 8 +-- docs/interfaces/types.MfaClient.html | 12 ++-- docs/interfaces/types.MfaContext.html | 14 ++--- docs/interfaces/types.MfaVerifyResponse.html | 20 +++--- docs/interfaces/types.Routes.html | 4 +- .../types.SessionConfiguration.html | 10 +-- .../types.SessionCookieOptions.html | 14 ++--- docs/interfaces/types.SessionData.html | 4 +- docs/interfaces/types.SessionDataStore.html | 16 +++-- .../interfaces/types.SessionStoreOptions.html | 10 +-- .../types.StartInteractiveLoginOptions.html | 6 +- docs/interfaces/types.TokenSet.html | 4 +- .../types.TransactionCookieOptions.html | 14 ++--- docs/interfaces/types.TransactionState.html | 12 ++-- .../types.TransactionStoreOptions.html | 6 +- docs/interfaces/types.User.html | 6 +- .../types.VerifyMfaOptionsBase.html | 6 +- .../types.VerifyMfaWithOobOptions.html | 8 +-- .../types.VerifyMfaWithOtpOptions.html | 6 +- ...ypes.VerifyMfaWithRecoveryCodeOptions.html | 6 +- docs/modules.html | 2 +- docs/modules/client.html | 2 +- docs/modules/errors.html | 2 +- docs/modules/server.html | 2 +- docs/modules/testing.html | 2 +- docs/modules/types.html | 2 +- docs/types/client.WithPageAuthRequired.html | 4 +- docs/types/server.AppRouterPageRoute.html | 4 +- docs/types/server.AppRouterPageRouteOpts.html | 6 +- ...r.GetServerSidePropsResultWithSession.html | 4 +- docs/types/server.PageRoute.html | 4 +- docs/types/server.WithPageAuthRequired.html | 4 +- .../server.WithPageAuthRequiredAppRouter.html | 4 +- ....WithPageAuthRequiredAppRouterOptions.html | 6 +- ...server.WithPageAuthRequiredPageRouter.html | 4 +- ...WithPageAuthRequiredPageRouterOptions.html | 6 +- .../testing.GenerateSessionCookieConfig.html | 4 +- docs/types/types.BeforeSessionSavedHook.html | 2 +- docs/types/types.DomainResolver.html | 4 +- docs/types/types.EnrollOptions.html | 4 +- docs/types/types.EnrollmentResponse.html | 4 +- docs/types/types.GetAccessTokenOptions.html | 4 +- docs/types/types.LogoutStrategy.html | 4 +- docs/types/types.LogoutToken.html | 4 +- docs/types/types.OnCallbackContext.html | 10 +-- docs/types/types.OnCallbackHook.html | 2 +- docs/types/types.PagesRouterRequest.html | 2 +- docs/types/types.PagesRouterResponse.html | 2 +- docs/types/types.ProxyOptions.html | 4 +- docs/types/types.ReadonlyRequestCookies.html | 2 +- docs/types/types.RoutesOptions.html | 2 +- docs/types/types.VerifyMfaOptions.html | 4 +- docs/variables/client.mfa.html | 4 +- .../client.withPageAuthRequired.html | 2 +- .../server.DEFAULT_ID_TOKEN_CLAIMS.html | 4 +- ...ypes.GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE.html | 4 +- docs/variables/types.GRANT_TYPE_MFA_OOB.html | 4 +- docs/variables/types.GRANT_TYPE_MFA_OTP.html | 4 +- .../types.GRANT_TYPE_MFA_RECOVERY_CODE.html | 4 +- package.json | 2 +- 134 files changed, 478 insertions(+), 463 deletions(-) diff --git a/.version b/.version index 4f0ba4027..5a74a2876 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v4.17.1 +v4.18.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index 4bfe143a6..9dcd00dc2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Change Log +## [v4.18.0](https://github.com/auth0/nextjs-auth0/tree/v4.18.0) (2026-04-17) +[Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v4.17.1...v4.18.0) + +**Added** +- Reapply feat: add optional update() to SessionDataStore (#2590) [\#2616](https://github.com/auth0/nextjs-auth0/pull/2616) ([Piyush-85](https://github.com/Piyush-85)) + +**Fixed** +- fix: DPoP nonce retry race issue [\#2580](https://github.com/auth0/nextjs-auth0/pull/2580) ([nandan-bhat](https://github.com/nandan-bhat)) + ## [v4.17.1](https://github.com/auth0/nextjs-auth0/tree/v4.17.1) (2026-04-16) [Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v4.17.0...v4.17.1) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 0dfd54fd0..8329097cd 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyll0tP4zAURv+L1xdonMR2uuM5QhoeoiNmgViY1KUWqd2xHTQM4r+PQgtym1S5gVWl1p/PsePe67wSZ23wZHzH8wIopZBydg/EqVmlyqCt8WT8SiilzYeRC0XGZKK819YcWzPTj7WTzTAC5EmbKRnTnAGpXUXGRJug3EyWyh+El6Xy+13B/XlYVARIWUnvyZgEP91rZtr7TDc/znU1dcqQ8R1Ns/s3IDTN2kaTYJ26Wq60BwjFOYTPG5CUswh/q5yevVzM5HqOI+kVit8VHLohKReQigRSkd+/m4kus986zK/Ccsjm7MgiN0gkOzXsw9c1PrNYjXyXxo0q7bNyL8d2OujM9E2CE2O0iMQuZvJG/am1U9NT56z7FEmo+BB5n0/5A6/cs3L725Gd2NUXDTLbQv6yT8qc/l0OxLZiCHSedqDPzbOs9GB0HOtHcxoXihO7kNrcKG+runlaWHZnDgFPkxb8tpGXw+FbOQw8rlHn3tfKDYd35hDwrKM+rxZyof1ChnKONdgdRmjk8ZmfTJ96oaoZ4Pc/hvYgNioxowWwrACWp8BpBjxNgKcMeJYBZxlwToFzDlxQ4IIDLyiIUQJixEAkOQg6AkEzECkFkWUgcgaCFSBEAsVIQCEYFAVrqjxn8fZeHdZhTrFLi0YjNpDHnf9E+1W9w7I2AxgcjwuF9l6bx0mQQWGJrQwCKuI1rsvLIGgrg4HyNnTjZjQQ3s4iJIp45c25sE7/G0Rvh/qxYpTswjaN9IeTJjTNTfnwJY3OSTBarFfrez5YkSS+tRzJ8qmcS2NU9dM+2hrt0B1E4OmoG98sSpmgy/dVXdowqZdL6wLi+tBW6pkMo5lhNL+thtVJN/5LZam8X12VsEdmK4JAbjTZKH9m3bE1ZvUG9wV+O4+QyeN/z3Htg12sr4rNtj6ii+muKEKBxd3+5Npeo/vUx1gEZOPN5uLlsCxtbcLhUqNb1HamH1qM4re69bNZz4Le13YKARZs8+Z+aQ+fpa7kQ6XOZBms8+hl7wwjNArW7pYDW0RHqg/89vYfEJXSwQ==" \ No newline at end of file +window.hierarchyData = "eJyll0tP4zAURv+L1xdI7CZ2uuM5QhoeoiNmgViY1KUWqd2xHTQM4r+PQgtym1S5gUVVqfXnc+wk9zqvxFkbPBnf8ZwBpTkwkdwDcWpWqTJoazwZvxJK8+bLyIUiYzJR3mtrjq2Z6cfayWYYAfKkzZSMaZYDqV1FxkSboNxMlsofhJel8vtdwf15WFQESFlJ78mYBD/da2ba+0w3f851NXXKkPEdZeL+DQhlom00Cdapq+VKe4BQnEP4vAFhIonwt8rp2cvFTK7nOJJeofhdwaEbwgQFJjJgorh/N6NdZr91mF+F5ZDN2ZHFblC2U8M+fF3jM4vVKHZp3KjSPiv3cmyng+6ZvklwYjljkdjFTN6oP7V2anrqnHWfIikVHyLv8yl/4JV7Vm5/O7ITu/qhQWZbyF/2SZnTv8uB2FYMg+Yd6HPzLCs9GB3H+tGcxoXixC6kNjfK26purhaW3ZlDwFnWgt828nI4fCuHgI/iGnXufa3ccHhnDgPvqM+rhVxov5ChnGMNdocRGnl8z0+mT71Q1Qzw+x9DexAblThnDPKs+XDgVABnGfBRAnwkgOcCOM+BixS4yIEXKfAiB5FkINIERFqAoCMQVIBgOYiRAJEnIDgDITIoUgpFkUCaJMn9+8Li/b06rMOcYtcWjUbsII9b/4n2q4KHZW0GEDiRxpVCe6/N4yTIoLDEVgYDjde4ri+DoK0MAlqkbejG0WggvJ3FSMQrb+4L6/S/QfR2qB8rkmwXtumkP5w0oeluyocvaXROgtBKk16t7/mgReJjy5Esn8q5NEZVP+2jrdEO3UEEno668c2ilAm6fF/VpQ2Term0LiDOD22lnskwmgKj+W01rA7beJbKUnm/Oithb5mtCAK50WWj/Jl1x9aY1SvcF/jtPEImj5+e49oHu1ifFZttfUQX011RhAKP2/3Jtb1G96mPsQjIxqvNxcthWdrahMOlRreo7Uw/tEjj17r1tVnPgt7XdgoBLpLNo/ulPXyWupIPlTqTZbDOo5e9M9yv0Zx72u1yYI/oSPWR397+A0YH0wk=" \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 11d92ad69..64b80ab2d 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)}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; } +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Ve),Ve())}async function Ve(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); /*! Bundled license information: diff --git a/docs/assets/search.js b/docs/assets/search.js index f15888f98..d58dfbc8a 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJzFnVuT2ziStv9L+ba2P+FAHfrObbt7vNNtO2z37E44JhS0xKriWCVqScpt78T89y8IkBKQeEEmKVXvTbu6ishMEolTPgngXzdl8Ud18+Onf918yffbmx/l7c0+fcxufrzZ7PJsX9/c3hzL3c2PN4/F9rjLqv9nf/3DQ/24u7m92ezSqsqqmx9vbv59e5KRzE9S/iuvH96l99nzY/3wPvufY15m27eHOi/21Ul0vq+z8i7dnKX3lAKab28OadnYejL6bIuYSX0ypti/KsuivEDxs2KftSL6DOiTEzfufbbNy2xT5/v7y0wsPUHXNrTM6mO5/1hcYqOVURfXMU/OVguRyF6nO1lbfz/0GzrSw9RZ7+NdelLzNS3z9LPTYh7v0umS/+h7o0AVenqk7vm5vhsps3dl8TXfZue2c3fcb0w9dEq9x6Zru8/q55tNVlUfiy/ZPq7Of266vmOV/V71vVf7wEgN56oz/UUV9KP217396PJcBec3NT3Yi2KbnSRm++PjSR56st/01j6nsZ9775+fv/711cv1x7fr969+fv/qw1/WH9/+9dWbkaqf3aX5Ltuu62JdZndlVj2s67Zy+0yCArGdv73+8OH1m18us/Ixr6p8f//UNn549eHD67eTrauyqsqLS+2CrvVz89h+nxn/5/sZLnYNp3v13y/+8vzNL68uMcFxvuzb5iHd32cjvl3kk1zRCftMv9Qjp1jPdU+O3eN9ddDis+O2zz3fbIrjvj49W2HLY09fw01fvP3t3a+vPkbctFez452b4vGwy+pB74y+94CVr9+8/vj6+aVW5vu8ztNrW8lyvn4TR/ocwz7H1Y5VXTzazrTtQwa6x74S012u6w/XtlYnqn7W9YNrW62Dn6rv7aGdr9/87fmvr1+uP/z+03++evHR9oTrj39/F3O+QZPz/dd0l2/X1fHzP7NNbXvCdTOVv771nTM+f/Hx7fsr2N55Zrqpi/JPsdz77pea7X3yK9l8blov3xXvBtqS98j0xvPy3dt36xdv3/z8+pff3z//+Prtm/Wr9+/fvucqfbY9FIf1ptjf5ffHMm0GqHV/LACJ6rHtP//6cf3i+a8vfv/VWtfXyGPm/fNLvd6ku81xZw3ktXCuhX999ff1q/9+9/b9x0nGfcm+r7Nvh6KsL7VLxpdGJ5NaybGZ9UhHSoQTGSv2VV0em+Y8Stszv+Co+XssGLNJj1U20oq2yHX0u82W+RG2F2nHdR9OHBlWhYX+NK+IqJ7oIuDtL/SXqH0jnWeEZTxPin+4UW7Vb5frY8f6oSjz/zX9adMP/VKm7YQxam28yBP714DiUd7V896TfGvQNpZnTbCqz6+GPxjDq3g2DfpUE6nNqimu5Zb8v/CwQP/ljuZ9jKvVLDJ0agXHLIzVM79e/+x6vEK9XalfuKg7uI6vXOIbfb7wU7r50iyI9tmuKZPt63wz7Bf9pZ7WRxi6x/jLwAeY4jssCzl+NNG2Hp/ifbxh/+JbxvG1N0X94XhoVmDZdprfBRL+j3wQ23EVfww/0jXrP2r4Bb7QazH2i1+L++LYP9fAT/9p9U11Tqxb90Uvq0dg0Kg6i1gie5FGzC7w6NPWTEzhmGpB7zel34/bwunsx1jR4xk9H2TYLQZskMPsIWpW5Pkn9o4+raNcJPa6k/yk3yqWs4y1p89jBj4Sw20Y1ji+8zKvNsXXrPze6zH+U0/rJ0DXGO8gLzShDrABw18+rlkCmBHV3j3wxF/ZUzPqA5/eYEp7o3o5DWxYY19t0hdlVCTS59Tha0saX7icp7dOowWeto771Y6p8/gbT6iRQbOGa4hlT1hjnPAZePRPqaWLAmTo/abXzLQQWL8NcqbP1VEX//nBSeHgWlEX/6yG0zYGvkXoFR/qtO6fMAUP/ikeQdRN8AfnzaZ7Q2gG2xewfqcGfrtLXzyku102NGUNHnzaGsDqxtRA+GZTRsuYHZxRk21BNv7DP2NlNYyzYL3Nqk2Zm8z9KdaQ8pMtk3MpNK+FRN2EtJC62v5HXv1Hvn/Iyrw2SQ2jLOL3nRGLQM95oU2kFb/al8Vu95gNhCTCJ5+8HSN9IxsyfbmJLRlbwmzKTBuG2jK0gduYx9jAbM1xe0Y257ht49pzxF0mNegem0a1aGjT5CbdU4t+m/4lq50YclFWQ00bF3jyFt6jdmRDj7zxxPbeaxez2Y+zaKj191nE7QQmWMTsCwatG9klDFo6rmfod7NJHcSwhaP6iT4LJ3cXw/Xt9xpviudf03zXbDb82aQzD3YbkRJP3m/06R3ZccReesKqa9iw4eXXeIuGeo5ek7hdxxSbmH3HsH0jOw+Grb7f/y0r87v+KLr/1JP7N9U10qfdF5o4AoYWMIc9hu4hjw10c72Uq5vpmdiOkd6IbRo3fgF3mDRoRWwZNVIFtkweniK15bZNu0llOMoXPPjELRSqG9VIgzebMt7EzGAMM3363Rr43kLs54e8vwbog09cA1DdqBoI3mxKDcTMYNQAV/82q9N8N9KCU6Hr2GD+GWdBW+Q6+qs6rY/VSAtOha5jQ53Xu7EfoStzJQvstsJRBjB2IrL1GzBwBnZj6+NcPOuKT7fL6aPeNosc2ds7OY88bb9EFY3pkdz3mNAXAdXDvVBEp/N1P2y/9H7a7u9jt25yX8uTz3qnk8XOFMc5s+q3u7RzqPdZdSj2zjzYOevoPE+hT1/ypv7Ul6+OPQUOXm30PHisUSPnw1wDH7OqSu+nVM2zc9ELjNFipdXsbM/L4jHN9++zqtgdw6wRcO7Ps60pUZ5KcKpw0IC/+X0wwwDS7U434HVVHbNyjAG5KXE1A367S7vzroZ1P96lZfvw1dQ2kffes54crd2z05W2iYAH9vuaPfyZLXD5Oxv1bTYAX33rbxeq/2CP+bAu/1tePab15mHYiPZ0EOv3j22xkaach/sqK79moUL7azAIRHaJfa7qMt3U7St9qIsyHOtamejZ/tGmtXH8fGVII2vi0iMkPtQXX/LMZn9NMaopvelKX82qBqu55zKyDToXDKIfh7Kosw2Jfkywrco2ZVaPN+1U7mpfqW1eL0wlvEFLQoZR5je2HnuXiFPsm9S2nnXFLrGDxPPy6v1Uj8or5FMTLHKjet2hIdlv6bfn9xO+0UnAY/qtb2o1wbZt1p6LNdKkU7mrWZIdis3DeEO6Ylez435Kc7+/uK17NlTTupyL+xuyv3r2wj+nmJpyfuSJx0miaNTw6LxHtMdwD5cd0m2fnaLT6xO8TUpjXrwplp6KXWxHmaV19nNmpmp8M0ypu1Opi60I997wbTFl29n3wCGUfIsiR+UOGXOfNXWTVVX/iV5T7fBOVplo1F1RblwZV7Dww+lcQLZBQ0cJjtJvvs1P38ke3jHmmC/z+fvns4TUSrjUusd8u91lf6Q9U6Ogg3GLXKq/qtOyft1Eb9JNnX/Nfi3uc35FmdL5ufSuLX2pVcfDNq2zsW5jS13Pc5qjvJ8fcnju95AtTdn0kDdeUp7LXsOi6FHkHJMO6X12uU3evrveyBuxCT78tHODuMoxswT8lqOyNxj29CZxTLIEhe45H6Ynjs+1I/CRWGwS2kUe/jN8BKkc7yP0LSfXTMQcbs302OHu1OqNGhO74MNPWzNxlWNqBr9lpGbSTX1Md7bIBLNs8bwrfj27+jym9zMNe8woO7JvBxM4m/yFOgFX+kZ+tiBGEMQ4+tzT+jDUNsZ9g9eaMu5ErOAMOWz9PR4a+wjDzsnVjvMWe9X3w4cp+ntzF4dtYdHakXY93qXrEhEyllmg9NWsqvuWznFzWEvnHjs4GZW9Rgxsl2Z8Cb/PiqPE0Jzg2Sfvu7DGkf1X+IrT+pCoMax+pNcKUCeQr0aMcp/9c+ok0DilTrxXvKBOkDH8OolZ4WY6DUNnYlq8xNPWz4DeMbXU89IT6mrYsOEa41nk1NvHMt1XqQkm9tJ1+tzT1hHUNqZmgteaxM+wGTx2Ns6C57swSZlhRLobqgO2HT3cDFvAYGYjdFsu/q7M7vJvo+2wRPzQFb6KTVX6daRftCUma/fTLGHWlJPHF0xjzJMjm6XfN3VnHoxU98wtyJxz2deKTdXNTu2xVpxKTTSB3pT5/HB4XxzrrGwiuuank0X2nswuBhs8N7IShhW/PTg+MKC8efYSLzikZfo4XtuzU7n+gDV+t2jOTFpuHt5NtMiWvpJdtJJ+abBZU/RDvs3elcWhep9Vx13d3JpKwYhnMaPghf4z4K/XclPGTbKtxvE3yU5SfqpDvhWnIk9pDr3TmW8V617n/uYc3Eg8TfvwrcQjJI78kCeHHVGx5zJPULNn4aOrNih6Sd3eB13JpYZYtN8UqvJtdmhFjq7w8ANdzTsjdl/inn3WOvdMv3z18/Pff/24fv2yvfjuxa/PX//24WT6+arpDvTgAiNr3LmP+S7f1Vn5MrtLj7v69dYszV/s0twZHM9XNLdGxMtMt+M+22dlWmcvD8Xhr9n3d2lexg0AD4/UHOzl6M6bfZFuHjLaBEGm+bNtV2LTlChOJaYacGarAznu7jaWr4MwpW9LwYuXv2V1uk3rtFff42b7eH6O2+edw61ZVbuJt52K9ve9efvhDMlW/Ac38Znkrtvm3knvKdHvMp3ZvCTwcUqHUsEZcvpbkVcAtKNOAXx+7Hdxqrr5CmFFN7/trebzCvn9qw/v3r758MrcAHruB+19h1aQ/8iAscYgpwrPy+EXb1/SK0aj8vvDZKhYTOebN81FoSN1m8y89SU2ODHV4I5Y/JXBc5M/9UnW39+9Wj9/8eLVhw/wrtR+zc9ON6N+P2Rrm704AIaiAhl29l0rPsZQ3mXiHEvdYE4sAZSOXE6cw6oYKDiyjv0wdJCFOkn7M0YqKktazFCTsbh+yJ0c62mGeoKewFB4+/IlBo+4znms4RHn/JDxPvKHbGC/QK/rpSAtm6PtGScxG5WOGnLc5tl+w6unsxXnUpebYLebVs/HffdnbbF0hCv3GFHaA8Oz7YdNwfTakyWnslVb9nJzqvFWXE/5yNZ7smBKI/XN8NrkOat3eIwInr2kbe52xR+v91W2OZZZe5D8eN3PjJi8FVOexfR+mPCdY0YeDj+lVfZ7CQnBgGWHw+e0yo7lwAcaY457y6EJVWd1Vk75aq6ggyvoOoZ+zu6Ksls9fEi/OtFato1WRpvCX7UyrmPexjz0vKqy0tCx/H6f7++f7+7HW2lFpZ2oyopKd/Fdodcx9q/Z92sZ+8WIuqaxrydUty2ZX7uSP/jr8ZHmDK3HR5q09aJJ443yY0vXM8sEjiaY05W7khkgxMe35VAcvmTfD7bw9QyaOigag4aif2MNyvZN0NcZ11/tt4eif8ESMc+Kcua52VnUNY0lN+xdaK+/p/WJTG4G1t0u2zn5ExPq38o6tLJqX9Y1zf2Y7bLHrC4njAdWQO0IuI5hD3V9+Jg/ZsVxQk03hetT4esYlO83u+M2a5nEX/J9/Xr/9vXLF/Yu0EnTu1ZkvjWtp1ns5/si3252RuQ1Z31W4oe6CcjeT6hlW746l7+OWY9twubHesLX604hquvrfad98aJoOoX6XVnc5busOyvsvx6y/e/79HzA+pTZ6L7YWOEHK7xshf/xkO2PgfDrvFCxf5Huds1G4/H2FvvNuex1zDkcq4ds+9xdOkxft1lh3jrk6qu3sgGtE2w7lbuOGdXEKeiVJ58VyRQaYUf/LuqJhvgpwGOt6T8LaLRJ+f3+9f59myHwLnVOBOAbZlZTXXLAIe05E2CseaarfG+BwU/Hu7tswgTZyGihw+dOxpXMO09uCFnkW3cWselEXMe4Y5U1d42ON+lYZc0c/hJDaKDtdMFHvzWnxy4KfTeHMIzR8+xUZOh9z6/RE6c6PfSxP8IJ7HB/xYlzckyyx9Bse8PfoSltqeHoN8eEfGDaQXSzQiGDSndp5d4tM/oLNOW92c11voX5Z4wdbYGLFRfF5xf21JZR6ovi8+ZU7GIjDg/FPntzfPw81JETK0y5fVfuYjMG2EOo/4LGSLvC06zvpTkAf2CWRp++oGMcfmmojPvuwXsxPgE3kg8KXDJCDDPJHp1sOBl50diiMv22jhwmzbDpXPqKJhXlfbpvn55oFxFxRePKbJuXDbo/lvlE44iIKxo3hFf7rGJx1kFz3CZHjvxqOylObsxQyYsa4ZiukGWID/e2J5l9X3Lw27CB5HWtH9hQc5nxn/P9Nt/f/xY/v36M3a20oSPtLzPZZBb9pTeAzrPWCGJkKE019JSsYbbY9wQteeaexGWduCsZzeog+m6fGNDIu4riz+gi/JsXrtlHDF0QkcPdA1MtbwPum07ak5hcD+aoMa01gvpO2x1vqOuyp6vDh100ePQClzz1nPVD0bOoxSrPPWVbuu/DhC84tKG4P9wQMelUmjHLZ5vULDXdIxi4xjRrzeGc7j4zPBfxAOzgXAc+fq3ea2iGEFc+YVqAX/yCJOUe69ipyaOMCnasjTFpcJfaBIPMpHxa/Z2KXmIM8Ou82A8nFIfPPnVScUTjiMRi8H6X+25gz1jHZZjDSDSOWcNNNuYbM7AEjRnCWX32GuF7agM0GD2v89gF/jmUzRXq4SVy+a/Rk/nxdr/rmfAD9U2hwha62IBH/94MjvqBmzJGKD/0gkOgmkEJWYqr9DH7kNfj3rspVOU9pwuNMcDkX49T3xW5WLmBh97tExz9bqkpJnhNPLyUYLi9R8tchv2Kcmhs6lf8zMhgDVHxtx40b2CazjaRM2Efb+Z2mzcPpDtOaH7Q2JM0dqb9BJMHo/mDZvIC+uNN4wXQh8wbEUMfb+LQNGHANtZ0YbxRdlfeha25lfI07dk18bIW7Zp5rTY90EMzYibxQk++gBhQPWYl0fPq/XP415cY2MoYnleON6+NKF5gXBtFvL5pbYbVpfa1Yp7IyPHdnW/dxP6OFXUd3Y2AgOu0DmQgkNZ/FExgKXz8gl7jMf32al+XeV/8Ja6zWeRkp+J9Hwa/ZqzG+nK/e6wZTvseMsOtmVfmNMa3xefBSqFPXhjY9HLcxqoN89yGqiZ4z1jv/ZjmPfWCrekKXcOAbmvAWBu6XQFXMuOc6zW6bs75XteqFFbOFzaGn/bVYwxoMPXw7jb65J/bYHy1kxvM+T0v9Vdi0Dh/RWZ4B/GCc7cCQ5yHnjBGSLXwIoTuC8Rmbv5NMcOKB26G6VNMDjkmF5SGqrtHxn1X/3LKvmONkRrGecakWEx1/CBjqHfgBGOm0ubKSbdR9jRpor+5aJKWvMiUr1mZ3/XEnYn+0+OjlRKvanaFfRtwK/vMk+ZqEjXcaI7zBtMT56lubtb8sPLH4bPJsQmPdynrqpoRhgyMEMACztgwrHpgsUb1ctZmUClx7L+ZBjIcIwkevTgyQi4DYmp8NuLkt/D1Lml30Bh28+MZ0gZT1r2DNjbFK3oVY/LtxCpyCl7FkDKza8T1pjfPJmINLX0lk/xj/caaxD8UkG3ScAeCTGH2IzwTOGddRexgH3fVZ4zbt70f2BVs//7U8V1Hy4hQbmt7LC0v3XxpF7z2YAOeeucm611XbLoRm8Et665u5ib1AZVe2hBTsXeSyEXqd9492b1a+y/FZipjV+wVavPxLuVO8F3Nj3fpqNn9oBEvhhdWRD93YTWo+tXAworoZS2sBpX+bWA1Q5SyVjP9SttzLXgqzw+PUuh2w6ejpZtTq4/lAB1GT1/SRX82d1VnL6crftbJ2J5l9H0M+L7RDq1/F33cKNbm+TGm5HuzLTyvv1/yrc5SnuBrNe3NPUh+hF3nohcYA72alfKHnn7CqF5UHS+8B99t0v7uuCGMbd5jzOhPyIubwcjLG2PGcHpe3BRmlt4ocwaS9XqM4eTsjTGFkboXt4abwTdgEGi/L3tj8M5D11kmDHcRJ13uYmFoVuW+zGDueJfEPMaWc+lun9MVTDJq92nPjCuwwylyofLhjV+BcuYWL4byY9WHRgLF7ePjlUYcfuBAJvrkBZiE3ITKUzV0Fyou2m/CT9/tQnlgsd5nz+fvdpnFuseBadw90wGZN6SOU16NVz7K+/vuIu1OjG4e4c6e3If/zCVBoLd/RVBX2//Iq//I9w9ZmdtTAvE38l7+sgVCaCJYHzyBYZOrrrWPd27uCLMmrGJC2wYWMVf9jtw1TWglWtJc1bSh4wyjlrHOMxxjCGu8AnYwjg7sN8Prsuq0rF83yu35ab82Ib7hBtBT6qq7bQf2LgzaMfGqgN6vMnm767C1zF2vTPPceh7eZfpn7S2duqP08ktqJl1Pc4X9otN2iQ4pHswi99XyUsaHb8Dh5IfTm2/YyeDXuoDngqt3LtySO34j7jUu2pl4xc7Azt+P9GDUwXEhVuIJo4K9KnmRweh7Ttyk228Sa7/uWJP6I4X9BjGihaPNKbO7/Ntkg7rS1zRpOIjZbxQzkDnarIFg5oBRnIAmw6RIq/9Qp8wPZp580gxBqIw9iNN36pmAfhg6aDxmSf3AO2qca0yT12NAat4XV8PWNGW/nstew5wRvZ5jyNjerteEfTHBRbpC1zCgKPP7fP+SPyQ5dtiyYwckhjmvB5LS+8xh5adzzekulejfA4fN6cpyZi1sc4YWZDFTWIswrhlDE0ZoA2viyDVgQi/+rCs00YDogMKJjEYKXDC8MON6fYpHxfZirxxbQ064uKnX1sm3N400fCiY1mskK6A2bJDrar/3Iqjmrxc40cC+xJN01l5EY2mfonU7fPccUEg0uiWmqr5LH/Pd93V//sNZr//4VKX3+ddsz9bpPT1VJVfZpWryzRe2qvOzU9UV5f2675qGs7LTk1NVHfJN3btwOes6PzpVWXX8zFFkHxuhxO06bMrib3dp28M0F+fGlaKnL9kdP7g/J6qQu1MHvt/Ap/ivvH7g7EuPFLjgg7SHrPYfQNqntjumlbE5Iva6l9cVsgtW1zDhGmnk4OGtvTbyjnAdNinuVIy925ECf04rAzqvU3ODm7mL+jDRPluSX2NDG7q9p9+3u40arxpXdaDkn1eHMeVXqUz0TQa2eo1olFHTO1ljm2i/uXK2WohEniz+KbgD/S9Fcd4WY+S3ZuNHxyZY+eptjOV9VhW7r86c3lXrP3KZOrtLotlsG2wZdVWGj11DLW1PocZJ7YYq+yWrnbuX+5TCJ68Z3eUp40Z38Yv1E8yxppyLXc0SPzDEtIMTGBqygjrGr/iGXtci/5HL/BDlLIa6zN8v8Lm8wr5NpT+zD/Z9T9fgWF06y65ebdXgqoujzVkP9WsbXBFhbbTK3p6u8qUHRrjqg6cu6TIOh2aF4t5tPazqWXo4fE6r7Dh4fXX4Qv0Z5tmWbs9kWHMqy9umybYJxtkZ9oyIsY+whQTZWXawAux9NsQdNDpL8R+5rAt7l95nldkfWLZ3SEOV4WNXVNszTQHPXai4LL5975sxuA881UQh0MGdH3jWx/ePfvvu3Zzcr9o8z8ic4OiOTwRCvZzxn6OzTsv7rO7rYkPdtgyvg43YQB3rfZZum7Pz2+Zh8xOwi+FHL/Nru8W3z7G9Jy5TRiNwUB99aJxK5cz23z9/83H98e/vXq1f/P7h49vf1h/f/vXVm/Wr/37xl+dvfnl10v41LfOGFp0mnwMFr2HRbz8/X799+xPHhvbRq2n9+I6t9eO7a2l9/+rF27+9ev/39Yu3L1lfPijEsuQftzf5fpt9u/nxX82BYiYX5ccb+YP6YXVze3OXZ7ttdfPjp45+bIrHR7v9cFtsjubHf7SP/S3bmHMPfvxkn/5/s5vbT7PbZPnDXCz+8Y/bT11h8wfzi07G+TemoLi5/SRQQREUFF5BeXP7SaKCMigovYLq5vaTQgVVUFB5BfXN7Sd9q+UPiVReQR0U1F7B5Ob2U3KrFz/MlfAKJkHBxCs4v7n9NL9N1A/JbOUVnAcF517BRUzjIii48Aoub24/LdDHWQYFl17B1c3tpyUydRUUXPkO0PjDCnpA6DuCOI/xHuh3AviP70CicQuBfS/0IeE7kWhcQ0D/E6EfCd+RROMeQqGvJUJfEr4zicZFhL5NZj8Irf3CoT8J36FE4yYigWaHPiV8pxKNq4g5LBz6lfAdSyzj7xz6lvCdS6zi7xz6l/AdTDY+I6BTy9DDpO9h0njYEhYOPUySLsp4GPRtCXop38Okir6zDD1M+h4mG5+RsGHI0MOk72Gy8RkJG4YMPUz6HiYbn5G4Yw49TPoeJhufkbBzlqGHSd/DZOMzUsPCoYdJ38Nk4zMSNgwZepj0PUw1PiNhw1Chhynfw1TjMxK6pwo9TPkepswoCN1ThR6myEDY+IyE7qnAWOh7mGp8Rs1u5eKHJCGFQw9TvoepxmeUuFXJDysyQKnQw5TvYarxGSUbzcu5XzZ0MOU7mGpcRuHRP3Qw5TuYWsZfOXQw5TuYWsVfOXQw5TuYnsVeWYf+pX3/0o3HKNgsdOhf2vcvLaOvrEP/0r5/aRV9ZR36lyaTLR19ZTDd8t1LG/eCjVmH7qV999Lz+CuH/qV9/9KLqNWhe2nfvbRxL9iL6NC9tO9eehW3OnQv7btXMotWVBL6V+L7VyJir5yE7pX47pUY94J9XxK6V+K7V6Kir5yE7pX47pXo+CuH/pWQ+XwSfWUwo/fdKzHuBXvsJHSvxHevZBF/5dC/Et+/kmXU6tC9Et+9EuNecKhIQvdKfPeaz6JWz0P3mvvuNY+61zx0r7nvXvPGYTScBc1D95r77jWPu9c8dK+5717zuHvNQ/ea++41j7rXPHSvOVkxNg6j4dxtDhaNvnvN4+41D91r7rvXfBl/5dC/5r5/zVfRVw7da+6716JxGA1nnIvQvRa+ey1E9JUXoX8tfP9ayJjVi9C9Fr57LRqH0XAmsgjda+G71yI++VqE7rXw3WsRn3wtQv9a+P61iE6+FqF7LUhQonEYDWciCxCX8N1rEZ98LUL3WvjutYi61yJ0r4XvXkvjXnAysQzda+m71zLuXsvQvZa+ey2j7rUM3Wvpu9fSuNf8VqsfVom/elyG7rX03WtpIl04DBS619J3r2USf+XQvZa+ey2j7rUM3Wvpu9fSuBccWZehey1J3CvuXksQ+vLdaxmf2y9D/1r6/rUy/rVCccVV6F8r379WjcckM1g49K+V71+rqH+tQv9a+f61ivvXKvSvle9fq8ZjEjhIrUL/Wvn+tYr71yr0r5XvX6t5tKZWoYOtfAdbLeI1FTrYynew1TJeU6GDrUhwNdp/rUB4lcZXZ9Gqsn/zizu/a8sbH8OhzhmIss5ImHUWX0Pav9HyJNI6iy8j7d9oeRJsnelotdm/0fIk3jpLojVn/0bLk5DrLNqn2T/R4iToOlv0VB8Iu85I3HVmHA9ONOzfaHkSep3FV5b2b7Q8cT8RjV0IFOAPIvwiXnswxk+8z8TtI7WHwvw0zm9C9wmctAgU6aehfhGfqgkU7KfRfhGfrQkU76cBfxPDj30/4H405m/C+LHvB9yPhv1FdNUpUNyfBv5NLD/i/Sj0T2L/woTzEww8QPRfkPC/kPEJnAAAQBACIGR0jBUAAQjCAIQJ6ycYuQAKIAgGELLH+wAIEIQECBldigqAAgRhAcKE9xM4kRSABgiCA4SJ8CdLBDIFAAKCEAFhgvwJhouACQgCBYSJ888xXwRYQBAuIEyofy4gtwJkQBA0IEy0fx6hjMD7CB0QJuA/x30/4AOCAAKh4jEQARCBIIxAqGgQVwBIIAglECbwP8d9L+AEgoACEScFAqACQViBMOH/Oe47AC0QBBcIQwAiXS8ABoIQA2EgQKTrBcxAEGggDAiY484DcANBwIEwLGC+wJgaeB9hB8LggDlMChCAHgiCD4QhAvMVLg+8jxAEYajAYobLI85O3M+AgQVuvYAjCAIShGEDC4n1A/8jLEEYPrCIpAkA/yM8QRhEsNC4PPA/ghSEoQQL7P8AKghCFYQBBQvsf4ArCAIWRNIz9gK2IAhcEIYXLPDoA/CCIHxBGGSwWOJMC+B/BDEIQw0Wq1ud/DCXCSkP/I9QBmHIwRKPPgA0CEIahIEHSwHrH7AGQWCDMPxgiUcfgBsE4Q3CMIQlHn0AchCEOQiDEZaRTBfgfwQ7CEMSlpFkF+B/hDwIQxOWc6gfwAdB6IMwQGGJ+0/AHwQBEMIwhSUMaAmAIARhEGLeM/kDFEIQDCEMWoDpZwKACEFIhDBwYYm7b8AiBIERwvCFFXZ/gCME4RHCIIYVzu8CREIQJCHm0ZQ2AaCEIFRCGNCwwq0HcAlBwIQwrGGFWw9AE4KwCWF4wwpPngCeEIRPCIMcVrj1AEIhCKIQhjqsItliwPsIpRAGPKxw7w04hSCgQhj4sMKtB7AKQWCFWERzKAWgFYLgCmEIRGTyBICFIMRCLHrCLgBaCEItxDLO9AXgFoKAC7GMclcByIUg6EIse+Z+gF4Igi/EsmflAQCGIARDLOMrD4AwBGEYwmCJyNQTUAxBMIZYxpNIBCAZgqAMYejECi9cAcwQhGaIZTzqAnCGIDxDGEQhZrjvBUhDEKYhDKaITL0B1RAEa4hVz9QPgA1ByIawaAN7P4AbgtANYYAF/n4AbwjCN8SqJ+QMCIcgiEOsekLOAHIIQjmEARdihsc+ADoEIR3CwAsxw6MXgB2C0A5hAEYkbgd4hyDAQxiIEVk7AeYhCPSQs3jOiQTQQxLoIWfR7k8C5iEJ85CGYeClmwTMQxLmIWfx7k8C5iEJ85CzaPcnAfKQBHlIgzDwylEC5CEJ8pCzePcnAfOQhHnIWTSNTgLkIQnykAZhiBnOIwbMQxLmIXuYhwTMQxLmIQ3EwCsXCaCHJNBDtvsacC4zoB6SUA9pKAZeukhAPSShHtJub5jhfGiAPSTBHtJucZjB6Z8E3EMS7iFFPPgiAfeQhHtIu9NhBidgEoAPScCHtLsdZnAKIwH5kIR8SLvjYYbT/wH7kIR9SLvrAW9vkQB+SLrxwe58wFtcJNr7QDc/2N0PeJuLRPsfgg0Qdo8NbolwDwRxRLsLQuCWgPZB0I0QhmjAabxEOyHoVghDNATeMSPRbgi6HcIgDYF3zUi0I4JuiTBMA247k2hPBN0UYZCGiGx/Qfsi6MYIab0Qb4FBeyMIBJHKeiFuB4CCSEJBpKEa+AsACCIJBJEGaojIZhhAQSShIFLZvV64GQEMIgkGkYZriMimGABCJAEh0oANIfF8ApAQSUiINGhDSDyiAxYiCQuRhm2IZoMMEgD8kMAQaeCGwJtkJKAhktAQaeiGwBtlJMAhkuAQafAGDsdKgEMkwSHS4A2BN9tIwEMk4SFSW0fEDQEAEUmAiDSAQ6jIti7giISIyPimCgmAiCRARBrAIRRuCICISEJEpCEcQuGGAJCIJEhEGsQh8AYeCZiIJExEarsNEY8nAIpIAkWkgRwCby6RgIpIQkWkoRxC4bkZwCKSYBFpMIfAuyYk4CKScBFpOIfAexAkACOSgBGZWD/EjgzIiCRkRBrSIfQMtkWARiRBIzKxm2DFrZ79IBLSHQE2IgkbkYZ1iCZrHNUC8EQCR6SBHULjLhnQEUnoiDS0Q2h9q5Y/SE0FAE8keEQmdlNsgl8BeCLhI9LwDqFxlwwAiSSARBrgIXCisASERBJCIg3xEBrPsQEikQSRyLndJLuC3wAwEkkYiTTMQyS4SwWQRBJIIg31EDiZVQJMIgkmkXO7JTuyYxZtmSWeaLiHwBl+EoASSUCJNOBD4Bw3CUiJJKREGvQhcJaVBKxEElYiDfsQyRz2BwCWSAJLpIEfAmcaSUBLJKEl0tAPkeA+EeASSXCJNPhD4FwjCXiJJLxEGv4hcLKRBMBEEmAiDQARc8h7JSAmkhATaQiIwOlGEiATSZCJXNgDAiL7t9EGbuKJBoIInPEjATWRhJpIQ0HEHE9TATaRBJtIg0EETpqRgJtIwk2kASFijj0RkBNJyIk0JETMsScCdCIJOpEGhYg59kTATiRhJ9LAEIGj9xLQE0noiTQ0JDLTBvREEnoiDQ0RC9ynAnwiCT6RBoeIBfZkwE8k4SfSABGxwJ4MCIokBEVagrKInEYAHJEQFLmyp1ZETiQAjkgQijRIROD0GwkYiiQMRRomInD+jAQQRRKIIg0VEQvsyQCjSIJR5Mo6IvZkwFEk4SjScBGxxJ4MQIokIEVakLLEnghAiiQgRVqQgpNoJAApkoAUafeNwBRYCUCKJCBFGjAicBaOBCRFEpKiDBkRSxg6UAClKIJSlGEjOAlWAZaiCEtRho2IJZznKgBTFIEpysCRmAHgoAsCU9RMxyeZCuAURXCKmvWsVhTgKYrwFDWzbhg5YQScekGAippZN4TRcAWQiiJIRVmkgpORFEAqiiAVNVvFlzsKMBVFmIoS1g/xcSUAqigCVZSFKhE/AlBFEaii7IFRK9ibKEBVFKEqylIVnJKkAFVRhKooS1VwUpECVEURqqLs4VE4q0gBrKIIVlEWq+C0IgWwiiJYRVmsEqsF4IkEqyiLVXBikgJYRRGsoixWWcEAjAJYRRGsoixWwalJCmAVRbCKslgF5yYpgFUUwSqqPVgKtwWAVRTBKspQEjnDrgywiiJYRbUHTGFXBmBFEbCiLFiJNCYAVhQBK8qCFRxHUwCsKAJWVBysKABWFAEryh43hVMkFAArioAVZY+cwpRaAbCi6KlTFqzgKJpCB0/Rk6eU6PmE6PApevqURSs4iqbQAVTBCVSqZ1SAh1ARP1TWDyFqV+ggKnoSlUUrOPSg0GFU9DQqQ0okRuUKnUhFj6QypETOIrUAPJEeS6WsJy6wAOCJ9GgqZT0RZrordDoVQSvKoBI5wzMkwFYUYSvKoBIpcG8A2IoibEUZVCIx6laArSjCVpRBJRKjbgXYiiJsRRlYIjHqVoCuKEJXlLbH7uGhFdAVReiKsnQlMs0EdEURuqJ03ywR0BVF6IrSPTFtBeiKInRFGVgiMW5XgK4oQleUgSUS43YF6IoidEUl1hPx4A7oiiJ0RVm6EumVAV1RhK6oxHoinh0AuqIIXVGJ9USYvaoAXVGErigDS6TErRHQFUXoimrpCvYDQFcUoSvKwBKJkbsCdEURuqIsXcHEXAG6oghdUQaWSMzsFaAritAVZWCJxIdZKkBXFKErysASiQ+0VICuKEJXlIElEjN7BeiKInRFGVgiJdwCogBdUYSuKANLpFzASRagK4rQFTW3nojbAqAritAVZelKJHoB6IoidEXNrSfiqTagK4rQFWVgSbQWgCcSuqLmq76PCDyR0BVl6UrEAkBXFKErqqUreI4E6IoidEUZWCJx4oICdEURuqIMLJE480ABuqIIXVGWruB0QAXoiiJ0RVm6gtMBFaAritAVZWCJxLkPCtAVReiKWtjDcSOHl6LTS4knGlgice6DAnRFEbqiLF2JTDAAXVGErihLV3A8VgG6oghdUQaW4KxQBeCKInBFLWVPWwJwRRG4opZ9CxYAVxSBK8qwEonzRxSAK4rAFWVgicTnhCpAVxShK2rZN00EdEURuqKW1hHxFAnQFUXoilpaR8S9OqAritAVZWCJxAkoCtAVReiKMrBE4qMhFaAritAVZelKxA8AXVGErihLV3D2hgJ0RRG6olq6gtsSoCuK0BW16knCUYCuKEJXlIElEh82qQBdUYSuKANLJD66UQG6oghdUQaW4C2mCsAVReCKWtkjw3GXCuiKInRFGVgi8ZmGCtAVReiKnllHxGcVA7qiCV3RhpZInMSjAV7RBK9oQ0skTuLRAK9ogle0wSUSH7ynAV/RhK9og0ukhq1ZA76iCV/RBpdInMSjAV/RhK9og0tkAlMnNOArmvAVbXCJTOB+JQ34iiZ8RRtcIhO4XtGAr2jCV7TBJfiwAg3wiiZ4RRtaInESkAZ4RRO8okXPJFEDvKIJXtH2pC5IOjWgK5rQFS1UPAymAV3RhK5ooeNhMA3oiiZ0RRtYEgmDaUBXNKEr2sCSSBhMA7qiCV3Rwvoh7k4AXdGErmhh/RB3J4CuaEJXtLAXKeDuBNAVTeiKltYRcXcC6IomdEW3dAXGUzWgK5rQFW1giUzgsKIBXdGErmhLV3AqlwZ0RRO6og0swfvHNIArmsAVbW/wmMORWQO4oglc0YaV4P1jGrAVTdiKNrAEBxI1gCuawBVt4QpORdMArmgCV3R7nwfu0QFc0QSuaHunR6RHB3BFE7ii7b0emExoAFc0gSva3u0RGRIAXNEErmgVP79GA7aiCVvRKn5+jQZoRRO0og0pwefPaEBWNCEr2pIVnE6oAVnRhKxou2kFJ25oQFY0ISvanuAFr/wCXEUTrqJVD2nWgKtoeu2H7iF8Gl39Qe/+sHtW8FpPo+s/6P0fuofwaXQFCL0DpOUquDNF14AE94DoeDBaw7tAiBvaXSs4U1+j+0DohSC6J5qt0Z0g9FIQy1XwWk+ji0HozSDadod4coYuB6G3g9hdK5HJGboghHAVbbkKhpQacBVNuIq2XCUyOwNcRROuog0mkfg4Pg24iiZcRVuuEpneAa6iCVfRlqtEpneAq2jCVbTlKji5WAOuoglX0UlP6EYDrqIJV9GWq+DsZA24iiZcRSfWE/HsDHAVTbiKtlwl5kjAEwlX0Zar4PRmDbiKJlxFW66ywLMzwFU04SrachWcnqwBV9GEq2jLVfDpFhpwFU24ijaYBI9LgKpoQlW03bMS6dAAVdGEqmgDSSROj9aAqmhCVbSlKjg9WgOqoglV0ZaqRGZXgKpoQlW03bOCd0toQFU0oSp6Ed9OqgFU0QSqaMNIYqsMAFU0gSraQhVM5zSAKppAFW2hCk4x1wCqaAJVtGEkEqeYawBVNIEq2jASiVPMNYAqmkAVbRhJJGYAmIomTEVbpoJT1DVgKpowFW2ZCk5R14CpaMJUtEEkEp/yqAFT0YSpaINIZGSaDZiKJkxFG0YicYq6BlBFE6ii+6CKBlBFE6iiDSOROEddA6iiCVTRFqoscXcCoIomUEVbqBJ7BeCIBKro5TyeUKkBVNEEqmgLVfBplRpAFU2girZQJfYKwBMJVNEWquAkcw2giiZQRVuossStGUAVTaCKXomeVwBQRROoog0jkThLXQOooglU0Svribg5A6iiCVTRFqrggxY0gCqaQBVtoQo+9lIDqKIJVNEWquAkcw2giiZQRRtIInGSuQZURROqolfLnlkqoCqaUBVtqQrOUteAqmhCVRK7ZwVPcBJAVRJCVZKZiO8jTABVSQhVSSxVwXnyCaAqCaEqiaUqOM09AVQlIVQlsVQFH8CZAKqSEKqSWKqCB5YEUJWEUJXEUhWcJ58AqpIQqpLYXSt4e3gCqEpCqEpiqQpOtE8AVUkIVUkMJYnM1BOAVRKCVRJDSeBMPQFQJSFQJTGMROJE/wRAlYRAlUTYy3dgd5IAqpIQqpIIexId7E4SQFUSQlWS9gIU2J0kgKokhKokomf3VAKoSkKoSiLsaXSwO0kAVUkIVUnsnpVIdwKoSkKoSmIvQcHnuSWAqiSEqiTCHkiHewNAVRJCVRJpz0PEvQGgKgmhKkl7EUrkrlbgiYSqJPYmlBlui4CqJISqJNJ6Im4LgKokhKok9jIUfJ5aArBKQrBKYm9DwUnmCcAq3e/+cXuT779mZZ1tX++32bebHz99ukk/V8XuWGfbY5nWebG/uf3XzTq3f27AhdF58+O/bhrY/OO//n170zCKH//173/fdkrtrzt15m+N/vRzVZfppq6yqsqLfVUXZeZKX8zPwptD91kyN5usqtZ18SXzLVWOsCbViC8skNUEuk+ymiNfTOlm14r9IZHtD6v2T024e6S+rCyL0nuBlWO/miRuU2y97yucyhNyrMi7RuB+n20apwjMVcoxd3G57MD2xLF9fpH84tD8t/KkK0d8czLSSPmV30gc12s49FhhWe3btnK9j+sKdf7V/4CLpSNmxRZTlGHbEtKpbD1WVP39kPniXN/RmivumO7yqjpmnh+unI/VnD7NkrXd5o1LpLtDWqaPWZ2VfoUK7RrI7Et2u+KPfF9lm2OZldn/HLOq9n1OL5wKmQue1MPhc1plx3Lni3Lrdt52R82skymzLI51Vh7S+8z85Mmeue7H9eZAZHEgby/cPlUwW9xxm2f7jW+fFm7zSNqueNb9oNtBqsn5tT8su2FLi/aHpPvNatl+OsGs5GP9MNvs8uZ3jk3LpdtZMdvHWRTqoPTcrWHm8NKIPJTF13zrNxLH8Zj1eawfsn2db9La7/abYzicXoU5qLjSaG/QHKvhSGT2BlSi336l07urrnk0+xm4sosy/18zGWqGpfsy3dfhAKjdTv8CyW1fESpwXoLbB7kKtlmd5jvfq5buh5l1H0aI7gdmB+KqCe12R8MJnxz3yU32hNMgVNfsuxkYdw4SaPK1rJxeSonuA0n+52/nup47zhduTfIM/Zxuvmwe0v0+2znODr+3Iz3hNcio8H1RV8fDoWhWCKEip5dLeFOyqCLU5S3dGbDgdXlRBWVWHYp95Xc1K3dcZ84qHQ274r44eh2/dAejJq18ksTwSztfIuENlZ+zu6LMupVW+jXb+rNpd/Sd8zrZUORDUXzxXt+tMs2cY37O99t8f08n/A01cfoNpolW1mNWVek9qWu3ZsQo0x6z+qHwv9/K8f3mFAyOtE262xx3aZ09pt+IdUtnBtxcN8YUt2tcx/c/d2a+4nn0Jj367UK5n6qbR626jrWbXLb/th3uvPu3nUEt2nLLttyqnWI1t2DbH0T7RHPDj/2BOX3YPKS7XbYn9TtzJyLiNOnj+c1JJO4mFm5l8zqik8RgfuOuUJrzT1jSgimm036ZBhkRaVVlpelq8/t9vr9Pd/d+v+BOpue8/gtL/pJ99yVLVzLTM43knHRdyhXEGz2toCrblGRtnWhXGLPhkZ5KuW2uW0m0Pq27+ciibS7t1KpbpyRtc5m3v5+3v5+3zWbRTjkWrdxuEbNsf9+tZVbt/69WXTPr2pvoWpdoVQkpux+6Fqh090NXaim6H7o/Lbviq7YBN3fLtD/o7of2LSVzEd98ya9Zmd/l/vqkyeNyZkjcajEBnnUQOXK7M8mcObfC0s2mOJK1nRtgmHf9zIrph57YYJx344xzZs8QSmw+gD+TcrtGZm/hiQWzs+aIJacb49a3kZptwXeV7pDa8K4RAskEW7hLDtmNVM05S23gljlen4SjsFxzQJLzAXizslAkiRy6KwNmUGTTRNLL44aszJW7culC1m0b1m0PoE9xj7Y36gb3th3P20/XLa/m7e8XbctftHIXrdyu11h2g3/7+1XX0XRLTDHr+inR9S+y63HkqTPqZgpdpym6SYbousHmer32h67nWp16pVn3w6nDmnc/cL9s8SX3J6XuKKa77k4rbqNq5G2K/V3ujbpuDEUwl2xWFmyY7qJGndbDXayLO8iVWdo0VH+4XLrLhq5W1ZL5+kbkXVZvHkjMduZ2qcye9FjVxaNlHd+a1ZM/HXRn+4L7yqHIsId25HInMRGxwYLH/bbM/jQUjTzC5T5KM/0rFI3mxtIdW1TC61i32V163NXrfGu53XqzS3MSePG+huLZvM12mR+8dteQImk7DdlNiTTzM1u56c6PubvtTArumzeSPn+36/wQrMxdvMqMMtm4nivGHUWE5HnpNq82xdes/L5JNw+EvLlsbM7rOn1xKLoj3Wn8aZXJnOudxIcN1OmgF7x+aVs8prk/gXAJnlx0E4iTld34p7tIqWYiQ6uqzAxhR8E7NzQoOj4hFsyvcpb+1e9hm8Q/52ufhn2m/xu5X9NdvsUhR3e6LrrJhVgyW+2hOKztoNhmHKxDGO7CfGatNmL/+aVed2GXRvBdmu/8SJh0+y9mI24kf8m+r7NvTWQUCfWiQ2yhoTM7bWTBC1md5ATDi9uKmd56KA5fsu+HNPedye1f5IL/0VA3kLjkcsH7Vtkj6fCk5x/dbFWPEbdu16HEOVzmwqyBbJ9+3mVuLsZ+eyjyPQk8uPhilGSy4kPC5+7gyQyBWeENAtntsl1dpvsq3YT15Y5QsgvyaeaoYHXU2S57zOrSjw/N3fjQgjdoZfuyoKOy609i0XXYvKHUymt+Bec67jxVM4P7VmRRfEYTM7dXVswMgFYgkObOeTUz9ttKq1HblF4KEnNenh2KzYM3BfMSd3h9d9gROpas2uF41Vau6MJPohuNRRf+FeoUtGI2gkbxeptVmzI/0LCCy0y6VWaXMCC6fAPRQULROZ/oQueC6zKNEX6rcxdITDdpJ+1odPISJpjSDiZuE+bbNJexOwk3zH7g2yEvs2qdk5Q9dyxm5u60osg61Z0FyuQU9+nCHsw1UCubWCncwZ2ZjmUrYV0X603xeKCrFOH1WSMFotWvcBMped/xLDDf53WeEgvd0Yr38c4Cy+yuzKqHMEfTTSNjErm79DHffV+bUt5A7SYZMEe8u3xXZ2W7GM23xjy0EnWbCzMT877JwGziJ5EZlHT9U/HM7WS2ADYMTgl32imZOShQahiiEu48WSpeM7/3I6ZL1ys74CG7/lIzF6r3WR1J03XevutxmfMSX6aXLOoFlVx/ZS4ufdFw2HZDikyO0Eh1U558iR6QYk6l7rPa1v2hzO7yb34X7y4dmA31PqurrPyalVW+zQ5lcSDZf26HwlzRhSLLrDru6j9ymGYj3LRSyey1jI5A1MrF88wFz31m4zufv5OcFE+wG59iLlfu86/ZHvSALjpgzndNvtm6IdRrG+9r43FoTFHuzDrhfs6zgse7dF0Un32Rbl6LZDoWEVkf/NSFmSuS2bP6IsvMxpYCkqjcQGrCnDo91PWh2O+8xY50W5RSvBbaCKrzx4ykHDXXGjoLJ17/QZD60h3imCuHLnjr9zzu3GjJi1q1I68/x3JXHslpVwXPQ+JD+cr97MxU5nxvcunz+jveEON8fT3r+Boz6JPvN7vjNmsNfsj3db4v8u3GhodpkvfcjeExQ4J5w4T3qR8tcWMumgmE2/jfujp+/mdD2W1HEaTye0keYwR7AcBw/ee8OtfFrdxYNq12XIHJr1qJVZ3WAAy5OdW8bievmrV3vvcmWkt3jsHMDc0rMqNw3i2ZMRtNsLKTHkFmDk5WTF+o2E2f0Cd6y+tLd2nlzntCPOm6H3MqtSvuyQLPjbqqFa+dGSnrBxqIc1e0kknHjKhAkjtLVILnYCg/1Y04rXizYyum2bpXZ/ckaOfODDson8zYLwohmDspSmY8v3tMv61pxufSgwa83ihMzWyOhHLG6g75d1klmpmP+5h+a8KKOd2Z4FYrV9Rm+5jV6TatU3+J5laGOoU+eZ0bSJmdu+s15o7GxzvPJkdCF5JjJhXaidj/HPMya35PwmEu3WfOVxqBYQRi5na3zB7j8S5ND7np2VCY2G0TgrkNoREZX8+5Y5WesSsC5slKdyORZrZUV1g48jmzCWbQrpEXZLRKL+2YiUQaScW+zr4RUW43x5wqPd6lIU+Q7riuuZ1RJ6n5bfC93BRbZlj68S4NVvyhXNeV+RW7L9Kvab5rwMyd2aMJJLvLX2Zm3uNd2jbfcOPIwg0ZdxmyYsV27Fi/sHC7Bd0G5KU4pSmxv0k4JnmYuEtDU/PTlsIuiHX+oUNjXQ6cXo1Tb4PP4OO51axPWW/MoaMV3k5lQ+FuTXc5y5Lv9nZ/b03WLW4yBXOu/XiXGiDrL5vdrkYzJ7YnSaFbu8EXZljrJA0CQneLnmKuAh7z7XaX/ZH6RyG4U3jB7Qvzqsr392vTimMLNC9YMEpsPIzvOU03ox8lG4XvvNStzs1bjxz3Qbw1q+9QrmeOkYkXgW6mlGAurB+/tyS/m1N4At0pGPOtaWTQXe0L2bXpDlzqU/ydGSje55svYfDRbZjMBfq+MCP3vj6UxV2+O6UX/vGQ7Y97b5nndyfumorZp+8LsmtcuutQzcTSRWOUDJe0rv8zIz/FHm3fEm4ilWTmT51FoZmQu3cpYS6CzhKDDX7u5qWEiaJBFMBdpzNllNk2Lxsm48dL3LU6T1LxuQ3G+4tFt2NkjqZnUWRR50ZBmeudRlaQEOwGYGSX1bRkVmJ5v85JNpPr88xZcVHep/t2f7T/wdwZUZcJrzSv7Rdlfp/vw8RL6U4NNTMjxgoDASx3PqiZ+2kIT5BLb/c6zy/wORrugCaZfXkjqbInabSBTJ+fuLCDeaKPJzKcwyh3bZ0wZ0Vg47yLSiRzKDykPh2T7p5Oddq8IrqWwAyoHR6KfbY/Pn4mmStucrjqdosoZlb/Id/UR3/OJt3dEXrB9JUAt8q5d9ADs1btGOpPbtzmPuPNRg9l8e07oNTKDZQkzPijEUYrVbn7phLmpvvDsXrItt5hDfBIHXdUl0ue85ZZum0AXSvQUnDy8m5AnbktK0oRpbubXzG7lE5auEvenXkxN1B3Q+n6WOZ+i3AHLuZCv10W+LMEF4oxB9Po8kK6uyIVM0rQSgMLeVdYtwtXM/erdjBpaxbnfijcfWfFPD7oJK/aFGSXuAshZLcfTzN3r3Yd+zo4Ckcob5cRt4VYccFi0o1F6C7tOmHuriuz+lju68KLJTrybDF5WrF0O9iUPG2760aELiCTME8JAdzNXcGIbh+k7rYpambelxlXyd5b94N3u6kV82wMKw/2x868JGGOr1X6mFV5TSaZbps/nfLQreM1M8GxOQ7ED6y7QR/meAFagTtn6vbKq65WVLdDVOnuT6dcz25jqFqdtuh0u166PfZJN+YnzBxJYx/ZbOnyG2YIodp+CdeQbrRD8Vp5laXl5gHNvdzlFTOhNDwbwV0tiC4HQ3YHG8hTgPO0xZRJmuyJeP5XdEfE09EJXdRHJ0z3Mclh3iu48RjmFi0UinIXEpK5/jolVDp5DX4WhjtbnHGr3MnSpFEYd/opkgkCUXZi4h1rxq1hI5QCSumGxzS3zZ1lBefFSnefi2YuqTqBZu35mFePqdmPTAPhbnvsehc5rpYCe4U7XkomK3OFoQpy981obg9EEnPdTYfzUz4u0z4SZFi5AxNz1WGPjOkmBHTFIFwqIZlZZVWdlrXJfrJHoQZpHisvR55pJxIKK8WdADPz+0xI2Z9euVKY69JGytEzxt1pJrgOQl3XzRAUp+MyuQPV0Uv7lK4w3Z3+lHAbV28CmnAzECVz8RyKJHNmt9lqZj10Mpus0tgh1cI9NVkyY2ee5B4o406dmOcutqJBPqYLtrgDqSMsPPLXTaphHvVdp+V9VoPjb5W7FT9hoqc6q2gsWbjbSKViyslrP+7iDkqCudO2Lv5Z+dMDN02jm8t2Jy+JbuIqurirEKc9ZkyrcetxM01kd16CWp32TfE81AhvPfPz8e6OxN0WHnXjfiBwMLbbhavuC+juIBnN3KWCHVR6Z+Ax3/u8aRbszll4G7CZLk8lwsHGnaIxW7q7vzcYd1xgr5kTSU8gnfe4IT/JjCtRgejNXU/SzA2qRm6QeyS805JOxzvw+nqS8CBdyK6YbJE6oLvPWpxuGuiOXFPM5IdwLHP39ErmPsjjYXveIebNodyJI3PPybEyu+L8puH2u8w8mWNFaI87z9HyRLXZ0qhAd9rEq0OS9ux9+Lm315FnFMiA8a9Z4Hm8FfN4l8I4knda8Bi7zgKbIdmf4LlrEiaiPwlttnNF9su7kFYzw/u+XLzR3d2jrpnrMk+uG56HCtwsQmbf38hND3kDPbpMOs893YAlM3ejEdnwv5hMF3NYEd38YtFFYZlbqpCm06UAfrDKHRaZe6p6paNTRtzppmRuTEFKkGynGibLPRFj8m3cVBfm0q1fPPw47pKJM2H9x+3NIT9ku3yf3fz46R///vf/B3DzDmY="; \ No newline at end of file +window.searchData = "eJzFnVuT2ziStv9L+ba2P+FAHfrObbt7vNNtO2z37E44JhS0xKriWCVqScpt78T89y8IkBKQeEEmKVXvTbu6ishMEolTPgngXzdl8Ud18+Onf918yffbmx/l7c0+fcxufrzZ7PJsX9/c3hzL3c2PN4/F9rjLqv9nf/3DQ/24u7m92ezSqsqqmx9vbv59e5KRzE9S/iuvH96l99nzY/3wPvufY15m27eHOi/21Ul0vq+z8i7dnKX3lAKab28OadnYejL6bIuYSX0ypti/KsuivEDxs2KftSL6DOiTEzfufbbNy2xT5/v7y0wsPUHXNrTM6mO5/1hcYqOVURfXMU/OVguRyF6nO1lbfz/0GzrSw9RZ7+NdelLzNS3z9LPTYh7v0umS/+h7o0AVenqk7vm5vhsps3dl8TXfZue2c3fcb0w9dEq9x6Zru8/q55tNVlUfiy/ZPq7Of266vmOV/V71vVf7wEgN56oz/UUV9KP217396PJcBec3NT3Yi2KbnSRm++PjSR56st/01j6nsZ9775+fv/711cv1x7fr969+fv/qw1/WH9/+9dWbkaqf3aX5Ltuu62JdZndlVj2s67Zy+0yCArGdv73+8OH1m18us/Ixr6p8f//UNn549eHD67eTrauyqsqLS+2CrvVz89h+nxn/5/sZLnYNp3v13y/+8vzNL68uMcFxvuzb5iHd32cjvl3kk1zRCftMv9Qjp1jPdU+O3eN9ddDis+O2zz3fbIrjvj49W2HLY09fw01fvP3t3a+vPkbctFez452b4vGwy+pB74y+94CVr9+8/vj6+aVW5vu8ztNrW8lyvn4TR/ocwz7H1Y5VXTzazrTtQwa6x74S012u6w/XtlYnqn7W9YNrW62Dn6rv7aGdr9/87fmvr1+uP/z+03++evHR9oTrj39/F3O+QZPz/dd0l2/X1fHzP7NNbXvCdTOVv771nTM+f/Hx7fsr2N55Zrqpi/JPsdz77pea7X3yK9l8blov3xXvBtqS98j0xvPy3dt36xdv3/z8+pff3z//+Prtm/Wr9+/fvucqfbY9FIf1ptjf5ffHMm0GqHV/LACJ6rHtP//6cf3i+a8vfv/VWtfXyGPm/fNLvd6ku81xZw3ktXCuhX999ff1q/9+9/b9x0nGfcm+r7Nvh6KsL7VLxpdGJ5NaybGZ9UhHSoQTGSv2VV0em+Y8Stszv+Co+XssGLNJj1U20oq2yHX0u82W+RG2F2nHdR9OHBlWhYX+NK+IqJ7oIuDtL/SXqH0jnWeEZTxPin+4UW7Vb5frY8f6oSjz/zX9adMP/VKm7YQxam28yBP714DiUd7V896TfGvQNpZnTbCqz6+GPxjDq3g2DfpUE6nNqimu5Zb8v/CwQP/ljuZ9jKvVLDJ0agXHLIzVM79e/+x6vEK9XalfuKg7uI6vXOIbfb7wU7r50iyI9tmuKZPt63wz7Bf9pZ7WRxi6x/jLwAeY4jssCzl+NNG2Hp/ifbxh/+JbxvG1N0X94XhoVmDZdprfBRL+j3wQ23EVfww/0jXrP2r4Bb7QazH2i1+L++LYP9fAT/9p9U11Tqxb90Uvq0dg0Kg6i1gie5FGzC7w6NPWTEzhmGpB7zel34/bwunsx1jR4xk9H2TYLQZskMPsIWpW5Pkn9o4+raNcJPa6k/yk3yqWs4y1p89jBj4Sw20Y1ji+8zKvNsXXrPze6zH+U0/rJ0DXGO8gLzShDrABw18+rlkCmBHV3j3wxF/ZUzPqA5/eYEp7o3o5DWxYY19t0hdlVCTS59Tha0saX7icp7dOowWeto771Y6p8/gbT6iRQbOGa4hlT1hjnPAZePRPqaWLAmTo/abXzLQQWL8NcqbP1VEX//nBSeHgWlEX/6yG0zYGvkXoFR/qtO6fMAUP/ikeQdRN8AfnzaZ7Q2gG2xewfqcGfrtLXzyku102NGUNHnzaGsDqxtRA+GZTRsuYHZxRk21BNv7DP2NlNYyzYL3Nqk2Zm8z9KdaQ8pMtk3MpNK+FRN2EtJC62v5HXv1Hvn/Iyrw2SQ2jLOL3nRGLQM95oU2kFb/al8Vu95gNhCTCJ5+8HSN9IxsyfbmJLRlbwmzKTBuG2jK0gduYx9jAbM1xe0Y257ht49pzxF0mNegem0a1aGjT5CbdU4t+m/4lq50YclFWQ00bF3jyFt6jdmRDj7zxxPbeaxez2Y+zaKj191nE7QQmWMTsCwatG9klDFo6rmfod7NJHcSwhaP6iT4LJ3cXw/Xt9xpviudf03zXbDb82aQzD3YbkRJP3m/06R3ZccReesKqa9iw4eXXeIuGeo5ek7hdxxSbmH3HsH0jOw+Grb7f/y0r87v+KLr/1JP7N9U10qfdF5o4AoYWMIc9hu4hjw10c72Uq5vpmdiOkd6IbRo3fgF3mDRoRWwZNVIFtkweniK15bZNu0llOMoXPPjELRSqG9VIgzebMt7EzGAMM3363Rr43kLs54e8vwbog09cA1DdqBoI3mxKDcTMYNQAV/82q9N8N9KCU6Hr2GD+GWdBW+Q6+qs6rY/VSAtOha5jQ53Xu7EfoStzJQvstsJRBjB2IrL1GzBwBnZj6+NcPOuKT7fL6aPeNosc2ds7OY88bb9EFY3pkdz3mNAXAdXDvVBEp/N1P2y/9H7a7u9jt25yX8uTz3qnk8XOFMc5s+q3u7RzqPdZdSj2zjzYOevoPE+hT1/ypv7Ul6+OPQUOXm30PHisUSPnw1wDH7OqSu+nVM2zc9ELjNFipdXsbM/L4jHN9++zqtgdw6wRcO7Ps60pUZ5KcKpw0IC/+X0wwwDS7U434HVVHbNyjAG5KXE1A367S7vzroZ1P96lZfvw1dQ2kffes54crd2z05W2iYAH9vuaPfyZLXD5Oxv1bTYAX33rbxeq/2CP+bAu/1tePab15mHYiPZ0EOv3j22xkaach/sqK79moUL7azAIRHaJfa7qMt3U7St9qIsyHOtamejZ/tGmtXH8fGVII2vi0iMkPtQXX/LMZn9NMaopvelKX82qBqu55zKyDToXDKIfh7Kosw2Jfkywrco2ZVaPN+1U7mpfqW1eL0wlvEFLQoZR5je2HnuXiFPsm9S2nnXFLrGDxPPy6v1Uj8or5FMTLHKjet2hIdlv6bfn9xO+0UnAY/qtb2o1wbZt1p6LNdKkU7mrWZIdis3DeEO6Ylez435Kc7+/uK17NlTTupyL+xuyv3r2wj+nmJpyfuSJx0miaNTw6LxHtMdwD5cd0m2fnaLT6xO8TUpjXrwplp6KXWxHmaV19nNmpmp8M0ypu1Opi60I997wbTFl29n3wCGUfIsiR+UOGXOfNXWTVVX/iV5T7fBOVplo1F1RblwZV7Dww+lcQLZBQ0cJjtJvvs1P38ke3jHmmC/z+fvns4TUSrjUusd8u91lf6Q9U6Ogg3GLXKq/qtOyft1Eb9JNnX/Nfi3uc35FmdL5ufSuLX2pVcfDNq2zsW5jS13Pc5qjvJ8fcnju95AtTdn0kDdeUp7LXsOi6FHkHJMO6X12uU3evrveyBuxCT78tHODuMoxswT8lqOyNxj29CZxTLIEhe45H6Ynjs+1I/CRWGwS2kUe/jN8BKkc7yP0LSfXTMQcbs302OHu1OqNGhO74MNPWzNxlWNqBr9lpGbSTX1Md7bIBLNs8bwrfj27+jym9zMNe8woO7JvBxM4m/yFOgFX+kZ+tiBGEMQ4+tzT+jDUNsZ9g9eaMu5ErOAMOWz9PR4a+wjDzsnVjvMWe9X3w4cp+ntzF4dtYdHakXY93qXrEhEyllmg9NWsqvuWznFzWEvnHjs4GZW9Rgxsl2Z8Cb/PiqPE0Jzg2Sfvu7DGkf1X+IrT+pCoMax+pNcKUCeQr0aMcp/9c+ok0DilTrxXvKBOkDH8OolZ4WY6DUNnYlq8xNPWz4DeMbXU89IT6mrYsOEa41nk1NvHMt1XqQkm9tJ1+tzT1hHUNqZmgteaxM+wGTx2Ns6C57swSZlhRLobqgO2HT3cDFvAYGYjdFsu/q7M7vJvo+2wRPzQFb6KTVX6daRftCUma/fTLGHWlJPHF0xjzJMjm6XfN3VnHoxU98wtyJxz2deKTdXNTu2xVpxKTTSB3pT5/HB4XxzrrGwiuuank0X2nswuBhs8N7IShhW/PTg+MKC8efYSLzikZfo4XtuzU7n+gDV+t2jOTFpuHt5NtMiWvpJdtJJ+abBZU/RDvs3elcWhep9Vx13d3JpKwYhnMaPghf4z4K/XclPGTbKtxvE3yU5SfqpDvhWnIk9pDr3TmW8V617n/uYc3Eg8TfvwrcQjJI78kCeHHVGx5zJPULNn4aOrNih6Sd3eB13JpYZYtN8UqvJtdmhFjq7w8ANdzTsjdl/inn3WOvdMv3z18/Pff/24fv2yvfjuxa/PX//24WT6+arpDvTgAiNr3LmP+S7f1Vn5MrtLj7v69dYszV/s0twZHM9XNLdGxMtMt+M+22dlWmcvD8Xhr9n3d2lexg0AD4/UHOzl6M6bfZFuHjLaBEGm+bNtV2LTlChOJaYacGarAznu7jaWr4MwpW9LwYuXv2V1uk3rtFff42b7eH6O2+edw61ZVbuJt52K9ve9efvhDMlW/Ac38Znkrtvm3knvKdHvMp3ZvCTwcUqHUsEZcvpbkVcAtKNOAXx+7Hdxqrr5CmFFN7/trebzCvn9qw/v3r758MrcAHruB+19h1aQ/8iAscYgpwrPy+EXb1/SK0aj8vvDZKhYTOebN81FoSN1m8y89SU2ODHV4I5Y/JXBc5M/9UnW39+9Wj9/8eLVhw/wrtR+zc9ON6N+P2Rrm704AIaiAhl29l0rPsZQ3mXiHEvdYE4sAZSOXE6cw6oYKDiyjv0wdJCFOkn7M0YqKktazFCTsbh+yJ0c62mGeoKewFB4+/IlBo+4znms4RHn/JDxPvKHbGC/QK/rpSAtm6PtGScxG5WOGnLc5tl+w6unsxXnUpebYLebVs/HffdnbbF0hCv3GFHaA8Oz7YdNwfTakyWnslVb9nJzqvFWXE/5yNZ7smBKI/XN8NrkOat3eIwInr2kbe52xR+v91W2OZZZe5D8eN3PjJi8FVOexfR+mPCdY0YeDj+lVfZ7CQnBgGWHw+e0yo7lwAcaY457y6EJVWd1Vk75aq6ggyvoOoZ+zu6Ksls9fEi/OtFato1WRpvCX7UyrmPexjz0vKqy0tCx/H6f7++f7+7HW2lFpZ2oyopKd/Fdodcx9q/Z92sZ+8WIuqaxrydUty2ZX7uSP/jr8ZHmDK3HR5q09aJJ443yY0vXM8sEjiaY05W7khkgxMe35VAcvmTfD7bw9QyaOigag4aif2MNyvZN0NcZ11/tt4eif8ESMc+Kcua52VnUNY0lN+xdaK+/p/WJTG4G1t0u2zn5ExPq38o6tLJqX9Y1zf2Y7bLHrC4njAdWQO0IuI5hD3V9+Jg/ZsVxQk03hetT4esYlO83u+M2a5nEX/J9/Xr/9vXLF/Yu0EnTu1ZkvjWtp1ns5/si3252RuQ1Z31W4oe6CcjeT6hlW746l7+OWY9twubHesLX604hquvrfad98aJoOoX6XVnc5busOyvsvx6y/e/79HzA+pTZ6L7YWOEHK7xshf/xkO2PgfDrvFCxf5Huds1G4/H2FvvNuex1zDkcq4ds+9xdOkxft1lh3jrk6qu3sgGtE2w7lbuOGdXEKeiVJ58VyRQaYUf/LuqJhvgpwGOt6T8LaLRJ+f3+9f59myHwLnVOBOAbZlZTXXLAIe05E2CseaarfG+BwU/Hu7tswgTZyGihw+dOxpXMO09uCFnkW3cWselEXMe4Y5U1d42ON+lYZc0c/hJDaKDtdMFHvzWnxy4KfTeHMIzR8+xUZOh9z6/RE6c6PfSxP8IJ7HB/xYlzckyyx9Bse8PfoSltqeHoN8eEfGDaQXSzQiGDSndp5d4tM/oLNOW92c11voX5Z4wdbYGLFRfF5xf21JZR6ovi8+ZU7GIjDg/FPntzfPw81JETK0y5fVfuYjMG2EOo/4LGSLvC06zvpTkAf2CWRp++oGMcfmmojPvuwXsxPgE3kg8KXDJCDDPJHp1sOBl50diiMv22jhwmzbDpXPqKJhXlfbpvn55oFxFxRePKbJuXDbo/lvlE44iIKxo3hFf7rGJx1kFz3CZHjvxqOylObsxQyYsa4ZiukGWID/e2J5l9X3Lw27CB5HWtH9hQc5nxn/P9Nt/f/xY/v36M3a20oSPtLzPZZBb9pTeAzrPWCGJkKE019JSsYbbY9wQteeaexGWduCsZzeog+m6fGNDIu4riz+gi/JsXrtlHDF0QkcPdA1MtbwPum07ak5hcD+aoMa01gvpO2x1vqOuyp6vDh100ePQClzz1nPVD0bOoxSrPPWVbuu/DhC84tKG4P9wQMelUmjHLZ5vULDXdIxi4xjRrzeGc7j4zPBfxAOzgXAc+fq3ea2iGEFc+YVqAX/yCJOUe69ipyaOMCnasjTFpcJfaBIPMpHxa/Z2KXmIM8Ou82A8nFIfPPnVScUTjiMRi8H6X+25gz1jHZZjDSDSOWcNNNuYbM7AEjRnCWX32GuF7agM0GD2v89gF/jmUzRXq4SVy+a/Rk/nxdr/rmfAD9U2hwha62IBH/94MjvqBmzJGKD/0gkOgmkEJWYqr9DH7kNfj3rspVOU9pwuNMcDkX49T3xW5WLmBh97tExz9bqkpJnhNPLyUYLi9R8tchv2Kcmhs6lf8zMhgDVHxtx40b2CazjaRM2Efb+Z2mzcPpDtOaH7Q2JM0dqb9BJMHo/mDZvIC+uNN4wXQh8wbEUMfb+LQNGHANtZ0YbxRdlfeha25lfI07dk18bIW7Zp5rTY90EMzYibxQk++gBhQPWYl0fPq/XP415cY2MoYnleON6+NKF5gXBtFvL5pbYbVpfa1Yp7IyPHdnW/dxP6OFXUd3Y2AgOu0DmQgkNZ/FExgKXz8gl7jMf32al+XeV/8Ja6zWeRkp+J9Hwa/ZqzG+nK/e6wZTvseMsOtmVfmNMa3xefBSqFPXhjY9HLcxqoN89yGqiZ4z1jv/ZjmPfWCrekKXcOAbmvAWBu6XQFXMuOc6zW6bs75XteqFFbOFzaGn/bVYwxoMPXw7jb65J/bYHy1kxvM+T0v9Vdi0Dh/RWZ4B/GCc7cCQ5yHnjBGSLXwIoTuC8Rmbv5NMcOKB26G6VNMDjkmF5SGqrtHxn1X/3LKvmONkRrGecakWEx1/CBjqHfgBGOm0ubKSbdR9jRpor+5aJKWvMiUr1mZ3/XEnYn+0+OjlRKvanaFfRtwK/vMk+ZqEjXcaI7zBtMT56lubtb8sPLH4bPJsQmPdynrqpoRhgyMEMACztgwrHpgsUb1ctZmUClx7L+ZBjIcIwkevTgyQi4DYmp8NuLkt/D1Lml30Bh28+MZ0gZT1r2DNjbFK3oVY/LtxCpyCl7FkDKza8T1pjfPJmINLX0lk/xj/caaxD8UkG3ScAeCTGH2IzwTOGddRexgH3fVZ4zbt70f2BVs//7U8V1Hy4hQbmt7LC0v3XxpF7z2YAOeeucm611XbLoRm8Et665u5ib1AZVe2hBTsXeSyEXqd9492b1a+y/FZipjV+wVavPxLuVO8F3Nj3fpqNn9oBEvhhdWRD93YTWo+tXAworoZS2sBpX+bWA1Q5SyVjP9SttzLXgqzw+PUuh2w6ejpZtTq4/lAB1GT1/SRX82d1VnL6crftbJ2J5l9H0M+L7RDq1/F33cKNbm+TGm5HuzLTyvv1/yrc5SnuBrNe3NPUh+hF3nohcYA72alfKHnn7CqF5UHS+8B99t0v7uuCGMbd5jzOhPyIubwcjLG2PGcHpe3BRmlt4ocwaS9XqM4eTsjTGFkboXt4abwTdgEGi/L3tj8M5D11kmDHcRJ13uYmFoVuW+zGDueJfEPMaWc+lun9MVTDJq92nPjCuwwylyofLhjV+BcuYWL4byY9WHRgLF7ePjlUYcfuBAJvrkBZiE3ITKUzV0Fyou2m/CT9/tQnlgsd5nz+fvdpnFuseBadw90wGZN6SOU16NVz7K+3uVHw/bdLxnnEpNNSFsEOYR7gTOffjPXJUEevsXJXW1/Y+8+o98/5CVuT2oEH8j7+UvW6OEJoIlyhMYNrnqWvt4R/eOMGvCQiq0bWAdddXvyF1WhVaiVdVVTRs6UTFqGetIxTGGsIZMYAfj9MJ+M7wuq07L+nWj3B7h9msTZRxuAD2lrrrhd2D7xKAdE28r6P0qk3fcDlvL3HjLNM+t5+GNrn/W9tapm1ovvydn0g05V9iyOm2j6pDiwUR2Xy0va334Eh5Oijq9fIedj36tO4AuuP3nwl3B4/cCX+Oun4m3/AxsPv5Iz2YdHBdiJZ4wMNmrkhecjL7nxH3C/SaxtgyPNak/WNlvECNgOdqcMrvLv002qCt9TZOG46j9RjFjqaPNGoinDhjFiakyTIq0+g9174KaPvmkSYpQGXsQp+/UMwH9MHTWecyS+oF32jnXmCa1yLDcvC+0h61pyn49l72GOSN6PceQsb1drwn7YoKLdIWuYUBR5vf5/iV/SHLssGXHDkgMc14P5MX3mcNKkeea091r0b8ND5vTleXMWtjmDC3IYqawFmFcM4YmjNAG1sSRa8CEXvxZV2iiAdEBhRMZjRS4YHhhxvX6FI+K7cVeObaGnHB3VK+tky+QGmn4UDCt10hWQG3YINfVfu+lYM1fL3Ciga2RJ+ms7ZDG0j5F63b47jkjkWh0S0xVfZc+5rvv6/4UjLNe//GpSu/zr9merdN7eqpKrrJL1eSbL2xV52enqivK+3XfTRFnZacnp6o65Ju6d+Fy1nV+dKqy6viZo8g+NkKJ23XYrMnf7tK2h2nu7o0rRU9fskF/cItQVCF3sxB8v4FP8V95/cDZGh8pcMEHac957T8DtU9td1IsY39G7HUvrytkF6yuYcI10sjB82N7beSdIjtsUtypGNvHIwX+nFYGdF6n5gb3kxf1YaJ9tiS/xob2lHtPv283PDVeNa7qQMk/rw5jyq9SmeibDOw2G9Eoo6Z3ssY20X5z5Wy1EIk8WfxTcA37X4rivDPHyG/Nxo+OzfHy1dsYy/usKnZfnTm9q9Z/5DJ1dqNGs9832LXqqgwfu4Za2p5CjZPaDVX2S1Y71z/3KYVPXjO6y1PGje7iF+snmGNNORe7miV+YIhpBycwNGQFdYxf8SXBrkX+I5f5IUqbDHWZv1/gc3mFfZtKf2Yf7PuersGxunSWXb3aqsFVF0ebsx7q1za4IsLaaJW9Pd0mTM+scNUHT13SZRwOzQrFvV57WNWz9HD4nFbZcfAG7fCF+pPcsy3dIcqw5lSWt1OUbROMszPsGRFjH2ELCbKz7GAF2PtsiDtodJbiP3JZF/Yuvc8qs0WxbK+xhirDx66otmeaAp67UHFZfPveN2NwH3iqiUKggzs/8KyPb2H99t27vLlftXmekTnB0R2fCIR6OeM/R2edlvdZ3dfFhrptGV4HG7GBOtb7LN02x/e3zcPmJ2AXw49e5td2l3GfY3tPXKaMRuCgPvrQOJXKme2/f/7m4/rj39+9Wr/4/cPHt7+tP77966s361f//eIvz9/88uqk/Wta5g0tOk0+Bwpew6Lffn6+fvv2J44N7aNX0/rxHVvrx3fX0vr+1Yu3f3v1/u/rF29fsr58UIhlyT9ub/L9Nvt28+O/mjPNTC7KjzfyB/XD6ub25i7Pdtvq5sdPHf3YFI+PdgfkttgczY//aB/7W7YxRy/8+Mk+/f9mN7efZrfJ8oe5mv/jH7efusLmD+YXnYzzb0xBcXP7SaCCIigovILy5vaTRAVlUFB6BdXN7SeFCqqgoPIK6pvbT/pWyx8SLb2COiiovYLJze2n5FYvfpgnXrkkKJd45eY3t5/mt4n6IZFLr+A8KDj3Ci4iChdBuYVXbnlz+2mBPs0yKLj0Cq5ubj8tkaWroODKr/7GG1aw/kPPEcR1jO9ArxPAe3z3EY1TCOx5oQcJ34VE4xgCep8IvUj4biQa5xAKfS0RepLwXUk0HiL0bTL7QcyVXzh0J+H7k2i8RCTQ7NClhO9TonEVMYeFQ78SvmOJZfydQ98SvnOJVfydQ/8SvoPJxmcEdGoZepj0PUwaD1vCwqGHSdJBGQ+Dvi1BH+V7mFTRd5ahh0nfw2TjMxI2DBl6mPQ9TDY+I2HDkKGHSd/DZOMzEnfLoYdJ38Nk4zMSds0y9DDpe5hsfEZqWDj0MOl7mGx8RsKGIUMPk76HqcZnJGwYKvQw5XuYanxGQvdUoYcp38OUGQOhe6rQwxQZBhufkdA9FRgJfQ9Tjc+o2a1c/JAsSOHQw5TvYarxGSVuVfLDSq/8wqGHKd/DVOMzSjaalwtSOPQw5XuYanxG4cE/9DDle5haxt859DDle5haxd859DDle5ieRd9Zhx6mfQ/Tjc8o2DB06GHa9zAto++sQw/TvodpFX1nHXqYJpMtHX9nMN/yPUwbD4PtWYcepn0P0/P4O4cepn0P04u42aGHad/DtPEw2JPo0MO072F6FTc79DDte1gyi1ZVEnpY4ntYIqLvnIQelvgelhgPgx1gEnpY4ntYoqLvnIQelvgeluj4O4celpApfRJ/ZzCt9z0sMR4G++0k9LDE97BkEX/n0MMS38OSZdzs0MMS38MS42FwxEhCD0t8D5vPombPQw+b+x42j3vYPPSwue9h88ZnNJwNzUMPm/seNo972Dz0sLnvYfO4h81DD5v7HjaPe9g89LA5WTk2PqPhJG4OFo++h83jHjYPPWzue9h8GX/n0MPmvofNV/F3Dj1s7nvYovEZDeeei9DDFr6HLUT0nRehhy18D1vIqNmL0MMWvoctGp/RcE6yCD1s4XvYIj4PW4QetvA9bBGfhy1CD1v4HraIz8MWoYctSHyi8RkN5yQLEKPwPWwRn4ctQg9b+B62iHvYIvSwhe9hS+NhcFqxDD1s6XvYMu5hy9DDlr6HLeMetgw9bOl72NJ42PxWqx9WC38tuQw9bOl72NJEvXBQKPSwpe9hyyT+zqGHLX0PW8Y9bBl62NL3sKXxMDjELkMPW5IwWNzDliAS5nvYMj7TX4YetvQ9bGU8bIWCjKvQw1a+h60an0lmsHDoYSvfw1ZxD1uFHrbyPWwV97BV6GEr38NWjc8kcKxahR628j1sFfewVehhK9/DVvNoVa1CD1v5HrZaxKsq9LCV72GrZbyqQg9bkWBrvA9bgXgrDbjOonVl/+YXd37XljdehmOfMxB2nZG46yy+pLR/o+VJ6HUWX1Xav9HyJPo609F6s3+j5UkAdpZEq87+jZYnMdhZvFuzf6PlSRh2tuipPxCInZFI7My4Hpxv2L/R8iQYO4uvM+3faHnifyIezBAo5h8E/UW8/mDYn/ifCeVH6g9F/mno30TzEzh3ESj4T6P/Ij5lEyj+TwGAiM/aBEIAlAGYsH7s+wH/oxjARPZj3w/4HyUBIr4EFYgFUBhg4vsR/0c4gPAAYUL8CYYggAgIggSEjM/jBIACglABIeMDrQBcQBAwIEysP8EcBqABQdiAkD3+B+iAIHhAyPi6VABAIAghECbon8AJpQCMQBBIIEzcP1kCuikAJRAEEwgT+U8wcQSgQBBSIEzwf46hI2AFgsACYeL/cwFhFsAFgvACYRDAPIIegfsRZCAMBZjj7h9AA0GogVDxgIgA3EAQcCBUPK4rADoQhB0IgwPmuPsF9EAQfCB6+IEAAEEQgiAMFJjj7gMwBEEggjBcINL9AowgCEcQBg1Eul9AEgRBCcLQgTnuPgBMEIQmCAMI5gtMr4H/EaAgDCOYw1wBAZCCIExBGEwwX+HywP8IVhCGFCxmuDzC78T/DCxY4PYL2IIgcEEYXrCQWD/wP8IXhEEGi0j2APA/ghiEoQYLjcsD/yOUQRhwsMD+DziDIKBBGHawwP4HUIMgrEEkPcMvoA2C4AZhCMICDz8AOAhCHISBCIslTsAA/keggzAcYbG61ckPc03LA/8j3EEYlLDE4w8gD4KgB2FowlLA+gfwQRD6IAxQWOLxB/AHQQCEMExhiccfgCAEYRDCYIVlJAEG+B/BEMKQhWUkBwb4HyERwsCF5RzqByxCEBghDF9Y4v4T4AhBeIQwiGEJA1sCEAlBkISY90z/AJQQhEoIAxpgUpoAWEIQLiEMalji7huQCUHQhDC0YYXdH8AJQeiEMMBhhdO+AJ8QBFCIeTTTTQBCIQiiEIY6rHDrAZBCEEohDHhY4dYDOIUgoEIY9rDCsyeAKgRhFcLghxVuPYBWCIIrhCEQq0gSGfA+QiyEgRAr3HsDZiEItBCGQ6xw6wHYQhBuIRaxzEoBuIUg4EIYFhGZOwF0IQi7EIue0AugF4LgC7GMU34BAIYgBEMs4xhWAIYhCMQQy565H8AYgnAMsexZewCSIQjKEMuetQeAGYLQDGEARWTuCXiGIEBDLOOZJQIgDUGYhjCYYoXXroBqCII1xLIn9ALAhiBkQxhYIWa49wVwQxC6IQywiEy+Ad8QBHCIVc/kDyAOQRiHsJADNwBAOQTBHMKQi8gHBKBDENIhVj2xZ8A6BIEdYtUTewa4QxDeIQzCEDM8/AHkIQjzEAZjiBkewAD2EIR7CIMyItE7QD4EQR/C0IzI8gnAD0Hoh5zF01AkoB+S0A85i3eBEtAPSeiHNDQDL98koB+S0A85i3eBEtAPSeiHnMW7QAnohyT0QxqagZePEtAPSeiHnMW7QAnohyT0Q87i+XUS0A9J6Ic0NEPMcJIxwB+S4A/Zgz8kwB+S4A9pcAZev0iAPyTBH7Ld9IATnQH/kIR/SMMz8AJGAv4hCf+Qdu/DDCdLAwAiCQCRdv/DDE4CJSAgkhAQKeIhGAkIiCQERNptEDM4D5MAgUiCQKTdCjGDExkJGIgkDETa7RAzvDcAQBBJIIi0WyLw3hcJKIikuyLstgi8/0WijRF0Z4TdGoH3wEi0OSLYHWE34OCWCDdIEEe0WyQEbglokwTdJWHIBprMS7RLgm6TMFxD4N00Eu2UoFslDNgQeEeNRLsl6HYJgzbghjSJ9kvQDROGbIjI1hi0Z4JumpDWCfH2GLRvgrAQqawT4mYAYIgkMEQauIG/AGAhkrAQadiGiGyUATBEEhgild0HhlsRoCGS0BBp6IaIbJgBOEQSHCIN3hASTygAD5GEh0jDN4TEIzoAIpIAEWkAh2g2zyABwA8JEZGGcAi8gUYCJCIJEpEGcQi8iUYCJiIJE5GGceCYrARMRBImIg3jEHgjjgRQRBIoIrV1RNwQABWRhIpIQzmEimz5Ao5IsIjs2W4hARaRBItIgzmEwi0BcBFJuIg0nEMo3BIAGJEEjEgDOgTe3CMBGZGEjEht9yji8QSgEUnQiDSoQ+BtJxKwEUnYiDSsQyg8NwNwRBI4Ig3sEHg3hQR0RBI6Ig3tEHhrggR4RBI8IhPriNiTAR+RhI9IwzuEnsHGCACJJIBEJnaHrLjVsx/EgvRHgJBIQkikIR6iSSRHtQA8kSASaZCH0LhPBoxEEkYiDfMQWt+q5Q9yviACgCcSSCITu2M2wa8APJFQEmmoh9C4TwaYRBJMIg32EDhvWAJOIgknkYZ7CI3n2ACUSAJK5NzuoF3BbwBIiSSkRBryIRLcpwJUIgkqkYZ9CJzZKgEskQSWyLndrx3ZTov20xJPNPRD4GQ/CXCJJLhEGvwhcLabBLxEEl4iDQARON1KAmIiCTGRhoCIZA77A4BMJEEm0iAQgROOJGAmkjATaRiISHCfCKCJJNBEGggicM6RBNREEmoiDQUROOlIAmwiCTaRBoOIOaS+EnATSbiJNBxE4LQjCcCJJOBELuzpAZHN3Wh3N/FEw0IETvyRAJ5IAk+kgSFijuepgJ5IQk+koSECp85IgE8kwSfS4BAxx54I+Ikk/EQaHiLm2BMBQJEEoEgDRMQceyIgKJIQFGmIiMARfAkQiiQIRRokEplqA4QiCUKRBomIBe5TAUORhKFIw0TEAnsygCiSQBRpoIhYYE8GFEUSiiItRVlEjioAjkgoilzZIy0ixxUARyQYRRosInASjgQcRRKOIg0XETiLRgKQIglIkQaMiAX2ZEBSJCEpcmUdEXsyQCmSoBRp0IhYYk8GLEUSliItS1liTwQsRRKWIi1Lwak0ErAUSViKtJtIUCasBChFEpQiDRoROBVHApYiCUtRho2IJQwdKABTFIEpysARnAurAExRBKYoA0fEEk5zFaApitAUZehIzABwCAahKWqm43NMBXCKIjhFzXoWKwrwFEV4ippZL4ycPgIOxCBARc2sF8JguAJERRGioixRwRlJChAVRYiKmq3iqx0FkIoiSEUJ64f4KBPAVBRhKsoylYgfAaaiCFNR9jCpFexMFIAqikAVZaEKzktSAKooAlWUhSo4s0gBqKIIVFH2YCmcWqQAVVGEqihLVXBukQJURRGqoixVidUC8ERCVZSlKjg7SQGqoghVUZaqrGD8RQGqoghVUZaq4PwkBaiKIlRFWaqCE5QUoCqKUBXVHjqF2wKgKopQFWUgiZxhVwZURRGqotrDp7ArA7CiCFhRFqxEGhMAK4qAFWXBCg6jKQBWFAErKg5WFAArioAVZY+iwkkSCoAVRcCKssdRYUitAFhR9EQqC1ZwEE2hQ6noqVRK9HxCdDAVPZnKohUcRFPocKrgdCrVMyrAA6qIHyrrh5C0K3RIFT2lyqIVHHlQ6KAqelKVISUSk3KFDquip1UZUiJnkVoAnkhPrFLWExdYAPBEemqVsp4I090VOriKoBVlUImc4RkSYCuKsBVlUIkUuDcAbEURtqIMKpGYdCvAVhRhK8qgEolJtwJsRRG2ogwrkZh0KwBXFIErStsj+fDQCuCKInBFWbgSmWYCuKIIXFG6b5YI4IoicEXpnpC2AnBFEbiiDCuRGLcrAFcUgSvKsBKJcbsCcEURuKIS64l4cAdwRRG4oixcifTKAK4oAldUYj0Rzw4AXFEErqjEeiLMYFUArigCV5RhJVLi1gjgiiJwRbVwBfsBgCuKwBVlWInEyF0BuKIIXFEWrmBirgBcUQSuKMNKJGb2CsAVReCKMqxE4oMuFYArisAVZViJxIddKgBXFIEryrASiZm9AnBFEbiiDCuREu4DUQCuKAJXlGElUi7gJAvAFUXgippbT8RtAcAVReCKsnAlEr0AcEURuKLm1hPxVBvAFUXgijKsJFoLwBMJXFHzVd9HBJ5I4IqycCViAYArisAV1cIVPEcCcEURuKIMK5E4cUEBuKIIXFGGlUiceKAAXFEErigLV3A2oAJwRRG4oixcwdmACsAVReCKMqxE4tQHBeCKInBFLezBuZFzTdHBpsQTDSuROPVBAbiiCFxRFq5EJhgArigCV5SFKzgcqwBcUQSuKMNKcFKoAmxFEbailrKnLQG2oghbUcu+BQtgK4qwFWVQicTpIwqwFUXYijKsROLzQxWAK4rAFbXsmyYCuKIIXFFL64h4igTgiiJwRS2tI+JeHcAVReCKMqxE4vwTBeCKInBFGVYi8XGRCsAVReCKsnAl4gcArigCV5SFKzh5QwG4oghcUS1cwW0JwBVF4Ipa9eTgKABXFIEryrASic+fVACuKAJXlGElEh/mqABcUQSuKMNK8D5TBdiKImxFrexx4rhLBXRFEbqiDCyR+IxDBeiKInRFz6wj4kOMAV3RhK5oQ0skzuHRAK9ogle0oSUS5/BogFc0wSva4BKJT+HTgK9owle0wSVSw9asAV/RhK9og0skzuHRgK9owle0wSUygZkTGvAVTfiKNrhEJnDHkgZ8RRO+og0ukQlcr2jAVzThK9rgEnxigQZ4RRO8og0tkTgHSAO8ogle0aJnkqgBXtEEr2h7ZBcCnRrAFU3gihYqHgXTAK5oAle00PEomAZwRRO4og0riUTBNIArmsAVbVhJJAqmAVzRBK5oYd0Q9yYArmgCV7Swboh7EwBXNIErWtg7FnBvAuCKJnBFS+uHuDcBcEUTuKJbuALDqRrAFU3gijasRCZwVNEArmgCV7SFKziRSwO4oglc0YaV4N1jGrAVTdiKtpd7zOHArAFb0YStaINK8O4xDdCKJmhFG1aC44gasBVN2Iq2bAUnomnAVjRhK9qyFZyIpgFb0YStaHvdR2REAGxFE7ai7ZUfkREBsBVN2Iq2135gsqEBW9GErWh79UdkSAFsRRO2og0qiQwpAK1ogla0imeBaUBWNCErWsUPsdEArGgCVrQFKziZUAOwoglY0XbPCk780ACsaAJWtOEk+DIxgFU0vRBEz3q6MnQnCL0UxG5ZwVN8je4FoReD2C0reK2o0d0g9HIQu2UFE0KN7gcJLgjpCWZreEcI8ULdE8zW6J4QelFIi1VwO0J3hdDLQixWwWtFje4LoReGtFgFrhU1ujOEXhpisQo+z06je0MIVtFJT362BlhFE6yiLVbBkFMDrKIJVtGJ7JneAayiCVbRFqvgxF4NsIomWEUnffNDgFU0wSo66ZsfAqyiCVbRhpJInFqsAVbRBKvods8Kbs4Aq2iCVXRiB2Y8OwNYRROsoi1WwbnJGmAVTbCKtlgl4kgAq2iCVbTFKgs8OwNYRROsoi1WwcnJGmAVTbCKtlgFJydrgFU0wSraYhV8voQGWEUTrKINJcHjEoAqmkAVPe/BexpAFU2girZQBSdHawBVNIEq2kIVnBytAVTRBKpoC1UisysAVTSBKtpCFbzZQgOooglU0YaRRGZHgKlowlT0om+ZApiKJkxFL3rongZMRROmohfWDXGPCpiKJkxFG0QicYK5BkxFE6aiLVPBCeYaMBVNmIpeRI8Z1oCoaEJUtCUqOD9dA6KiCVHRBpBIfNCjBkRFE6KiDSCROD9dA6KiCVHRhpDIJV6nAKSiCVLRFqngBHMNkIomSEUvVZzJaIBUNEEq2iKVJe5NAFLRBKloi1TwcZEaIBVNkIo2hCT6CsAPCVLRFqngfEwNkIomSEVbpIIzxDVAKpogFb3socwaIBVNkIq2SGWJGzNAKpogFb2ynogbM0AqmiAVveqBexogFU2QijaEROIUcw2QiiZIRRtCIvHBlRogFU2Qirb7VfA5DRogFU2QirZIBaeYa4BUNEEq2iASiVPMNWAqmjAVbZkKTjHXgKlowlT0qocya8BUNGEqiWUqOEc9AUwlIUwlmfXAvQQwlYQwlcRuWcG7EBPAVBLCVBLLVHCSewKYSkKYSmKZCj6DMwFMJSFMJbFMBSe5J4CpJISpJJap4IElAUwlIUwlsUwFZ8kngKkkhKkkds8K3lyeAKaSEKaSGEYicZp9AqBKQqBKYqEKnqgnAKokBKokInr0TQKQSkKQSiLsLTywP0oAVEkIVEmEPYgOdicJgCoJgSpJew8K7E4SAFUSAlUSexEKzpJPAFRJCFRJRE+6QwKgSkKgSmIYicJnsSUAqiQEqiSiJys2AVAlIVAlEfY0OtwbAKiSEKiSSHseIu4NAFRJCFRJ2utQIhe4Ak8kUCWx96HMcGMGUCUhUCWR1hNxWwRQJSFQJbE3ouDD1BJAVRJCVRJ7JQpOMU8AVUkIVUkMJVE4xTwBWKX73T9ub/L916yss+3r/Tb7dvPjp0836eeq2B3rbHss0zov9je3/7pZ5/bPDbcwOm9+/NdNw6p//Ne/b28aRPHjv/7979tOqf11p878rdGffq7qMt3UVVZVebGv6qLMXOmL+Vl4c3A/S+Zmk1XVui6+ZL6lyhHWZCrxhQWymjj3SVZzYIwprexb3940edb2h1X7pybaPVJfVpZF6b3AyrFfTRK3Kbbe9xVO5Qk5VuRdI3C/zzaNUwTmKuWYu7hcdmB74tg+v0h+cWj+W3nSlSO+OVdppPzKbySO6zUce6ywrPZtW7nex3WFOv/qf8DF0hGzYospyrBtCelUth4rqv5+yHxxru9ozRV3THd5VR0zzw9XzsdqDrBmydpu88Yl0t0hLdPHrM5Kv0KFdg1k9iW7XfFHvq+yzbHMyux/jllV+z6nF06FzJk9xuHwOa2yY7nzRbl1O2+7o2bWyZRZFsc6Kw/pfWZ+8mTPXPfjenMgsjiQtxdunyqYLe64zbP9xrdPC7d5JG1XPOt+0O0g1aQM2x+W3bCl2w/VwAj7w6p9JuF2Mcf6YbbZ5c3vHJuWS7ezYraPsyjUQem5W8PMsbEReSiLr/nWbySO4zHr81g/ZPs636S13+03h3g4vQpzUHGl0d6gOZTDkcjsDahEv/1Kp3dXXfNotkNwZRdl/r9mMtQMS/dluq/DAVC7nf4Fktu+IlTgvAS3D3IVbLM6zXe+Vy3dDzPrPowQ3Q/M/tNVE9rtjoYTPjnuk5vkCadBqK7ZdzMwNVWTr2Xl9FJKdB9I8j9/O9f13HG+dGuSZ+jndPNl85Du99nOcXb4vZ0WmfAaZFT4vqir4+FQNCuEUJHzGgmvv4wqQl3e0p0BC16XF1VQZtWh2Fd+V7Nyx3Vml+9o2BX3xdHr+KU7GDVZ6ZMkhl/a+RIJb6j8nN0VZdattNKv2dafTbuj75zXyYYiH4rii79mccRqZt/9Od9v8/09nfBLt2/SzAVcK+sxq6r0ntS1WzOCNyafxNUPhf/9Vo7vN4docKRt0t3muEvr7DH9RqxbOjNgwewRNulu17iO73/uzHzF8+hNevTbhXI/VTePWnUdaze5bP9tO9x59+/S/rtoyy3bcqt20tXcp21/EO0TzTVB9gfm9GHzkO522Z7U78ydiIjTpI/ngyeRuJtYuJXN64hOEoP5jbtCaY5PYUkLpphOQ2MaZESkVZWVpqvN7/f5/j7d3fv9gjuZnvMaHZb8JfvuS5auZKZnGsk56bqUK4g3Q7GCqmxTkrV1ol1hzIZHeirltrlubdH6tO7mI+0KI2mnVt06JWmby7z9/bz9/bxtNot2yrFo5XaLmGX7+24ts2r/v1vAiC42J0TXukSrSkjZ/dC1QKW7H7pSS9H90P1p2RVftQ24uZum/UF3P7RvKZmL+OZLfs3K/C731ydNGpczQ+KNeG2AZx1EjtzuTDJnzq2wdLMpjmRt5wYY5l0/s2L6oSc2GOfdOOOc2TOEEpsP4M+k3K6R2Vt4YsHsrDmhyenGuPVtpGZb8F2l2y82vGuEQDLBFu6SQ3YjVXNMUxu4ZY7XJ+EoLNecr+R8gLH2diJJ5NCpKc0MimyaSHp53JCVuXJXLl3Ium3Dp8BH11t1YY9ucG/b8bz9dN3yat7+ftG2/EUrd9HK7XqNZTf4t79fdR1Nt8QUs66fEl3/IrseR546o26m0HWaoptkiK4bbK7oa3/oeq7VqVeadT+cOqx59wP3yxZfcn9S6o5iuuvuNNuhGnmbYn+Xe6OuG0MRzCWblQUbpruoUaf18KnKme9eZmnTUP3hcukuG7paVUtmn2JE3mX15oHEbGdul8rsSY9VXTxa1vGtWT3500F3ti+443ooMuyhHbncSUxEbLDgcb8tsz8NRSOPcLmP0kz/CkWjubF0xxaV8NrBNrtLj7t6nW8tt1tvdmlOAi/e11A8m7fZLvOD10vttqy205DdlEgzP7OVm+78mLvbzqTgvnkj6fN3u84PwcrcxavMKJON67li3FFESJ6XbvNqU3zNyu+bdPNAyJvLxpjdhy8ORXekO40/rTKZa9+T+LCBOh30gtcvbYvHNPcnEC7Bk4tuAnGyshv/dBcp1UxabVWVmSHsKHg3d6tOd+PegvlVztK/+j1sk/jnfO3TsM/0MCP3a7rLtzjk6AY0RTe5EEtmqz0Uh7UdFNuMg3UIw12Yz/zUjdh/fqnXXdilEXyX5js/Eibd/ovZiBvJX7Lv6+xbExlFQr3oEFto6MxOG1nwQlYnOcHw4rZiZiM+FIcv2fdDmvvO5PYvcsH/aKgbSFxyueB9q+yRdHjS849utqqZn8yIW7frUOIcLrtgxpKyffp5l7m5GPvtocj3JPDg4guuoUYyWfEh4XN38BxldoNAdrtsV5fpvko3YX25I5Tsgnya2dNaHXW2yx6zuvTjQ3M3PrTgDVrZvizoqOz6k1h0HTavo7Pyml/BuY47qdTM4KoVWRSf0cTM7ZUVMwOgFQikrdy1CTMg0UqrUduUXgoSc16eHYrNgzcF8xJ3mH4SdISOJat2OF61lSu68JPoRmPRhX+FOgWtmI2gUbzeZtWmzA80rOAyk26VueoUdPkGooOEonM+0YXOBXO4NUb4rc5dIDHdpJ20o9HJS5hgSjuYuE2Yb9Nc5+4k3PAGluzbIS+zap2TlD13LGbm7rSiyDrVnQXK5BT36dbAzJSlVjaxUriDOzMdy1bCui7Wm+LxQFcpwuuzRgpEq1/hJlLyvuNZYL7P6zwlFrqjFW+QPgsss7syqx7CHE03jYxJ5O7Sx3z3fW1KeQO1Gzhj9vZ3+a7OynYxmm+NeWgl6jYXZibmfZOB2cRPIjMo6fqn4vVNncwWwIbBKeFOOyUzBwVKDUNUwp0nS8Vr5vd+xHTpemUHPGTXX2rmQvU+qyNpus7bdz0uc7Xqy/SSRb2gkuuvzCmPLxoO28odtnkrvUaqm/LkS/SAFHMqdZ/Vtu4PZXaXf/O7eHfpwGyo91ldZeXXrKzybXYoiwPJ/nM7FOaKLhRZZtVxV/+RwzQb4aaVSmavZXQEotwqEswFz31m4zufv5OcFE+wG59irn7u86/ZHvSAblIRt9KbfLN1Q6jXNt7XxuPQmKLcPNBmD8RIBY936booPvt5BjNXJLMbJCLrgy9SuCJ5AwERWWY2thSQROUOWAmzv3qo60Ox33mLHem2KKX4gur8MSMpR82liM7CiTfaE6S+dIc45sKmC976PY87N1ry+rJ25PXnWO7KIzntquB5SHwoX7mfnZnKnO9NLn1ef8cbYtzee9bxNeY0Id9vdsdt1hr8kO/rfF/k240ND9Mk77kbw2OGBPOGCe9TP1rixlw0Ewi38b91dfz8z4ay244iSOX3kjzGCPYCgOH6z3l1rotbubFsWu24ApNftRKrOq0BGHJzqpl+WjVr73zvTbSW7hwjYb5qRWYUzkQrmXGNoSs76RFk5uBkxfSFit30CX2it7yOepdW7rwnxJOu+zEjILvinizw3KirYk7IjJT1Aw3EuStayaRjRlQgyZ17KsGrU5Sf6kacVrzZsRXTbN2rs3sStHNnhh2UT2Y8X4lBMLeXTma8nvQx/bamGZ9LDxrweqMwNbM5EcoZqzvk3+UkaGZI6zH91oQVc7ozwa1WZqLT42b7mNXpNq1Tf4nmVoY6hT6Z9oUps3N3vaaZYu48mxwJXUiOmVRoJ2L/c8zLrPk9CYe5dJ85X2kEhhGImdvdMnuMx7s0PeSmZ0NhYrdNCOZWyEZkfD3njlV6xq4ImCcr3Y1Eesbrklxh4cjnzCaYQbtGXpDRKr20YyYSaSQV+zr7RkS53RxzqvR4l4Y8QbrjumZ2bCdJzW+D7+Wm2DLD0o93abDiD+W6rsyv2H2Rfk3zXQNm7sweTSDZXf4yNxU+3qVt8w03jizckHGXIStWbMeO9QsLt1vQbUBeilOaEvubhGOSh4m7NDQ1P20p7IJYXT6aPm0y7BLgNTO7vVNvg8/g47nVrE9Zb8yhoxXeTmVD4W5NdznLku/2dn9vTdYtbjIFc679eJcaIOsvm92uRnNnBp2k0K3d4AszrHWSBgGhu0VPMVcBj/l2u8v+SP2jENw5kOD2hXlV5fv7tWnFsQWaFywYJTYexvecppvRj5KNwnde6lbn5q1Hjvsg3prVdyjXM8fIxItAN1NKMBfWj99bkt/NKTyB7hSM+dY0Muiu9oXs2nQHLvUp/s5cV+/zzZcw+Ojm6zPH231hRu59fSiLu3x3Si/84yHbH/feMs/vTtw1FbNP3xdk17h0xyDNRO9FY5QMl7Su/zPTfYo92r4l3EQqycyfOotCMyF3o1oy41XxWSLd4Kdc2pswzxABUQB3nc6UUWbbvGyYjB8vcdfqPEnF5zYY7y8W3Y6ROZqeRZFFnRsFZa53GllBQrAbgJGnmQWzEsv7dU6y0lyfXzDfsbxP9+3+aP+DuTOiLhNeaa5x+X2+DxMvpTuF08wtMFYYCGC5UyXNPIaB8ATpvqZmTlHxORrugCaZfXkjqbInabSBTL81urCDOYPxRIZzGOWuiBNmoAlsnHc5jGQOhYfUp2PS3dOpTptXRNcSmFslDg/FPtsfHz+TzBU3OVx1u0UUM6v/kG/qoz9nky5G0cyJbohbpTtf1swEk3YM9Sc37qDMDAMfyuLbd0CplbvbKRG8Ps0Io5Wq3Lz5hJmdcjhWD9nWO6wBHqnjRpflkvfpyizdNoCuFWgpOHl5N6DOdOYoRZTubn7FzJjqpIW75N1KZp7q1A2l62OZ+y3CHbiYC/12WeBPOtwqZgasossL6e6KVMwuuJUGFvKusG4XrmbuCu1g0tYszv1QuJsjoJgN5CSv2hRkl7gLIeTpfCLN65y6jn0dHIUjlLfLiOsvVlywmHTDBbqLiiTMozrKrD6W+7rwYomOPFtMnlYsqjuVRp623XWhlW7XdMJMjgTczU2fEN0+SN1tU9TMHC0zrpK9t+4H73ZTK25LNfJgf+yd8sJ77Sp9zKq8JpNMt82fvmi3jtcJ78Wb40D8wLob9GFOI0ArcOdM3V551dWK6naIKt396ZTr2QXiVJepq7twlu42bSfdBvaEGa0w9pHNli6/YYYQqu2XcA3pRjsUr/eosrTcPKC5l7u84vpGcDaCu6YXXQ6G7A42kN0eX61OmwDYmujEyU0tUqejE7qoj06436Mk254WbjyGeaojCkW5qxK55PXBp4RKJ6/Bz8JwV2Mz7is6WZo0CuMu7wT7mzkCUXZi4h1rxuvZW6EUUEo3PKaZMz9HVnBerHT3uWjmkqoTaNaej3n1mJr9yDQQ7rbHrneR42opsFe4C1LJXMe7wlAFudEnzdzYRY4ycNe4Yn7Kx2XaR4IM7mE5CfeDmSNjugkBXTEId5ohmVllVZ2Wtcl+skehBmkeKy9HnjlAIaGwUtxWw2TAJqTsT69cKcz9N42Uo2eMu9NMcIco6rru0lZ0g6xmZi5WRy/tU7ppOro7MyJhZmj0J6AJNwNRMgMEoUgyZ3abLXMKfpLZZJXGDqkW7qnJkhk78yT3QBl36sQ8d7EVDfIxXbDFHUgdYeGRv25SDXPzdJ2W91kNjr9Vbjptwjw2pc4qGksW7jZSyTxBss5rP+7iDkqC2SHXxT8rf3rgpml0c9nu5CXRBatEF3cV4rTHjGk1bj1uponszktQq9O+qRHCW8/8fLy7I3G3hUfduB8IHIztduGq+wJanib8TLeCDiq9M/B4LdPZNAt25yy8DdhM26hEONi40ypm43T39wbjjkvYNPNkT08gnfe4wUPJjCtRgejN3U+qmae8GLlB7pHwTks6He/AfPea7EZ3Q0HM/EDqgO4+a3G6aaBbsSpm8kM4lrl7eiXzLJjjYRu4iDuEMycVVgzaXuPOP5mb946V2VzntzC3+17xVqPHikAjd7qk5QmOM79UlVGB7uyL5woke9qrv7m3ZZL3iiCRxr+tgde7WTGPdykMR7mYmbnXigpsRnZ/nugubZg0/CS02RUW2Xbvgh/NTNPx5eL98kvvpGteo/DkulF+qMDNf2I6eCM3PeQNO+kS8jz3dOOezG1jjcgGI8ZkurMxK6Kbpiy6YC5zsxfSdLpbwI95uaMrc99Xr3R0WIk7a5XM/S1ICZLtVMNkuSfwTL6NmzHD7Kz7xcOP4668OPPef9zeHPJDtsv32c2Pn/7x73//f/szbV4="; \ No newline at end of file diff --git a/docs/classes/errors.AccessTokenError.html b/docs/classes/errors.AccessTokenError.html index 2fca32f4b..5e0c59b3c 100644 --- a/docs/classes/errors.AccessTokenError.html +++ b/docs/classes/errors.AccessTokenError.html @@ -1,4 +1,4 @@ -AccessTokenError | @auth0/nextjs-auth0 - v4.17.1
@auth0/nextjs-auth0 - v4.17.1
    Preparing search index...

    Class AccessTokenError

    Hierarchy (View Summary)

    Index

    Constructors

    constructor +AccessTokenError | @auth0/nextjs-auth0 - v4.18.0
    @auth0/nextjs-auth0 - v4.18.0
      Preparing search index...

      Class AccessTokenError

      Hierarchy (View Summary)

      Index

      Constructors

      constructor

      Properties

      cause? code -

      Constructors

      Properties

      cause?: OAuth2Error
      code: string

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      +

      Constructors

      Properties

      cause?: OAuth2Error
      code: string

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      diff --git a/docs/classes/errors.AccessTokenForConnectionError.html b/docs/classes/errors.AccessTokenForConnectionError.html index ba225ed8f..01b520ef8 100644 --- a/docs/classes/errors.AccessTokenForConnectionError.html +++ b/docs/classes/errors.AccessTokenForConnectionError.html @@ -1,11 +1,11 @@ -AccessTokenForConnectionError | @auth0/nextjs-auth0 - v4.17.1
      @auth0/nextjs-auth0 - v4.17.1
        Preparing search index...

        Class AccessTokenForConnectionError

        Error class representing an access token for connection error. +AccessTokenForConnectionError | @auth0/nextjs-auth0 - v4.18.0

        @auth0/nextjs-auth0 - v4.18.0
          Preparing search index...

          Class AccessTokenForConnectionError

          Error class representing an access token for connection error. Extends the SdkError class.

          -

          Hierarchy (View Summary)

          Index

          Constructors

          constructor +

          Hierarchy (View Summary)

          Index

          Constructors

          constructor

          Properties

          cause? code

          Constructors

          Properties

          cause?: OAuth2Error
          code: string

          The error code associated with the access token error.

          -

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          +

          Returns AccessTokenForConnectionError

          Properties

          cause?: OAuth2Error
          code: string

          The error code associated with the access token error.

          +

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          diff --git a/docs/classes/errors.AuthorizationCodeGrantError.html b/docs/classes/errors.AuthorizationCodeGrantError.html index f1d79729e..6228bd9c4 100644 --- a/docs/classes/errors.AuthorizationCodeGrantError.html +++ b/docs/classes/errors.AuthorizationCodeGrantError.html @@ -1,4 +1,4 @@ -AuthorizationCodeGrantError | @auth0/nextjs-auth0 - v4.17.1
          @auth0/nextjs-auth0 - v4.17.1
            Preparing search index...

            Class AuthorizationCodeGrantError

            Hierarchy (View Summary)

            Index

            Constructors

            constructor +AuthorizationCodeGrantError | @auth0/nextjs-auth0 - v4.18.0
            @auth0/nextjs-auth0 - v4.18.0
              Preparing search index...

              Class AuthorizationCodeGrantError

              Hierarchy (View Summary)

              Index

              Constructors

              constructor

              Properties

              cause code -

              Constructors

              Properties

              cause: OAuth2Error
              code: string = "authorization_code_grant_error"

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              +

              Constructors

              Properties

              cause: OAuth2Error
              code: string = "authorization_code_grant_error"

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              diff --git a/docs/classes/errors.AuthorizationCodeGrantRequestError.html b/docs/classes/errors.AuthorizationCodeGrantRequestError.html index a1cbbadaf..33f19d3fd 100644 --- a/docs/classes/errors.AuthorizationCodeGrantRequestError.html +++ b/docs/classes/errors.AuthorizationCodeGrantRequestError.html @@ -1,3 +1,3 @@ -AuthorizationCodeGrantRequestError | @auth0/nextjs-auth0 - v4.17.1
              @auth0/nextjs-auth0 - v4.17.1
                Preparing search index...

                Class AuthorizationCodeGrantRequestError

                Hierarchy (View Summary)

                • SdkError
                  • AuthorizationCodeGrantRequestError
                Index

                Constructors

                constructor +AuthorizationCodeGrantRequestError | @auth0/nextjs-auth0 - v4.18.0
                @auth0/nextjs-auth0 - v4.18.0
                  Preparing search index...

                  Class AuthorizationCodeGrantRequestError

                  Hierarchy (View Summary)

                  • SdkError
                    • AuthorizationCodeGrantRequestError
                  Index

                  Constructors

                  constructor

                  Properties

                  code -

                  Constructors

                  Properties

                  code: string = "authorization_code_grant_request_error"

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  +

                  Constructors

                  Properties

                  code: string = "authorization_code_grant_request_error"

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  diff --git a/docs/classes/errors.AuthorizationError.html b/docs/classes/errors.AuthorizationError.html index 76e1d262d..f96a08863 100644 --- a/docs/classes/errors.AuthorizationError.html +++ b/docs/classes/errors.AuthorizationError.html @@ -1,4 +1,4 @@ -AuthorizationError | @auth0/nextjs-auth0 - v4.17.1
                  @auth0/nextjs-auth0 - v4.17.1
                    Preparing search index...

                    Class AuthorizationError

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor +AuthorizationError | @auth0/nextjs-auth0 - v4.18.0
                    @auth0/nextjs-auth0 - v4.18.0
                      Preparing search index...

                      Class AuthorizationError

                      Hierarchy (View Summary)

                      Index

                      Constructors

                      constructor

                      Properties

                      cause code -

                      Constructors

                      Properties

                      cause: OAuth2Error
                      code: string = "authorization_error"

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      +

                      Constructors

                      Properties

                      cause: OAuth2Error
                      code: string = "authorization_error"

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Properties
                      diff --git a/docs/classes/errors.BackchannelAuthenticationError.html b/docs/classes/errors.BackchannelAuthenticationError.html index edfdd0cbe..8cb7b8441 100644 --- a/docs/classes/errors.BackchannelAuthenticationError.html +++ b/docs/classes/errors.BackchannelAuthenticationError.html @@ -1,4 +1,4 @@ -BackchannelAuthenticationError | @auth0/nextjs-auth0 - v4.17.1
                      @auth0/nextjs-auth0 - v4.17.1
                        Preparing search index...

                        Class BackchannelAuthenticationError

                        Hierarchy (View Summary)

                        Index

                        Constructors

                        constructor +BackchannelAuthenticationError | @auth0/nextjs-auth0 - v4.18.0
                        @auth0/nextjs-auth0 - v4.18.0
                          Preparing search index...

                          Class BackchannelAuthenticationError

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor

                          Properties

                          cause? code -

                          Constructors

                          Properties

                          cause?: OAuth2Error
                          code: string = "backchannel_authentication_error"

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Properties
                          +

                          Constructors

                          Properties

                          cause?: OAuth2Error
                          code: string = "backchannel_authentication_error"

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Properties
                          diff --git a/docs/classes/errors.BackchannelAuthenticationNotSupportedError.html b/docs/classes/errors.BackchannelAuthenticationNotSupportedError.html index ebcc2ebb9..dbfa4f312 100644 --- a/docs/classes/errors.BackchannelAuthenticationNotSupportedError.html +++ b/docs/classes/errors.BackchannelAuthenticationNotSupportedError.html @@ -1,3 +1,3 @@ -BackchannelAuthenticationNotSupportedError | @auth0/nextjs-auth0 - v4.17.1
                          @auth0/nextjs-auth0 - v4.17.1
                            Preparing search index...

                            Class BackchannelAuthenticationNotSupportedError

                            Hierarchy (View Summary)

                            • SdkError
                              • BackchannelAuthenticationNotSupportedError
                            Index

                            Constructors

                            constructor +BackchannelAuthenticationNotSupportedError | @auth0/nextjs-auth0 - v4.18.0
                            @auth0/nextjs-auth0 - v4.18.0
                              Preparing search index...

                              Class BackchannelAuthenticationNotSupportedError

                              Hierarchy (View Summary)

                              • SdkError
                                • BackchannelAuthenticationNotSupportedError
                              Index

                              Constructors

                              constructor

                              Properties

                              code -

                              Constructors

                              Properties

                              code: string = "backchannel_authentication_not_supported_error"

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              +

                              Constructors

                              Properties

                              code: string = "backchannel_authentication_not_supported_error"

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              diff --git a/docs/classes/errors.BackchannelLogoutError.html b/docs/classes/errors.BackchannelLogoutError.html index c91e99b92..110fde47b 100644 --- a/docs/classes/errors.BackchannelLogoutError.html +++ b/docs/classes/errors.BackchannelLogoutError.html @@ -1,4 +1,4 @@ -BackchannelLogoutError | @auth0/nextjs-auth0 - v4.17.1
                              @auth0/nextjs-auth0 - v4.17.1
                                Preparing search index...

                                Class BackchannelLogoutError

                                Error thrown when backchannel logout processing fails.

                                -

                                Hierarchy (View Summary)

                                Index

                                Constructors

                                constructor +BackchannelLogoutError | @auth0/nextjs-auth0 - v4.18.0
                                @auth0/nextjs-auth0 - v4.18.0
                                  Preparing search index...

                                  Class BackchannelLogoutError

                                  Error thrown when backchannel logout processing fails.

                                  +

                                  Hierarchy (View Summary)

                                  Index

                                  Constructors

                                  constructor

                                  Properties

                                  code -

                                  Constructors

                                  Properties

                                  code: string = "backchannel_logout_error"

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  +

                                  Constructors

                                  Properties

                                  code: string = "backchannel_logout_error"

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  diff --git a/docs/classes/errors.ConnectAccountError.html b/docs/classes/errors.ConnectAccountError.html index 10eae4841..9417da7f5 100644 --- a/docs/classes/errors.ConnectAccountError.html +++ b/docs/classes/errors.ConnectAccountError.html @@ -1,6 +1,6 @@ -ConnectAccountError | @auth0/nextjs-auth0 - v4.17.1
                                  @auth0/nextjs-auth0 - v4.17.1
                                    Preparing search index...

                                    Class ConnectAccountError

                                    Error class representing a connect account error.

                                    -

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor +ConnectAccountError | @auth0/nextjs-auth0 - v4.18.0
                                    @auth0/nextjs-auth0 - v4.18.0
                                      Preparing search index...

                                      Class ConnectAccountError

                                      Error class representing a connect account error.

                                      +

                                      Hierarchy (View Summary)

                                      Index

                                      Constructors

                                      constructor

                                      Properties

                                      cause? code -

                                      Constructors

                                      Properties

                                      cause?: MyAccountApiError
                                      code: string

                                      The error code associated with the connect account error.

                                      -

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Constructors
                                      Properties
                                      +

                                      Constructors

                                      Properties

                                      cause?: MyAccountApiError
                                      code: string

                                      The error code associated with the connect account error.

                                      +

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Constructors
                                      Properties
                                      diff --git a/docs/classes/errors.CustomTokenExchangeError.html b/docs/classes/errors.CustomTokenExchangeError.html index 51df75765..59439b340 100644 --- a/docs/classes/errors.CustomTokenExchangeError.html +++ b/docs/classes/errors.CustomTokenExchangeError.html @@ -1,15 +1,15 @@ -CustomTokenExchangeError | @auth0/nextjs-auth0 - v4.17.1
                                      @auth0/nextjs-auth0 - v4.17.1
                                        Preparing search index...

                                        Class CustomTokenExchangeError

                                        Error class representing a Custom Token Exchange error. +CustomTokenExchangeError | @auth0/nextjs-auth0 - v4.18.0

                                        @auth0/nextjs-auth0 - v4.18.0
                                          Preparing search index...

                                          Class CustomTokenExchangeError

                                          Error class representing a Custom Token Exchange error. Extends the SdkError class.

                                          This error is thrown when a Custom Token Exchange operation fails, such as validation errors or server-side token exchange failures.

                                          Auth0 Custom Token Exchange Documentation

                                          -

                                          Hierarchy (View Summary)

                                          Index

                                          Constructors

                                          constructor +

                                          Hierarchy (View Summary)

                                          Index

                                          Constructors

                                          constructor

                                          Properties

                                          cause? code

                                          Constructors

                                          Properties

                                          cause?: OAuth2Error

                                          The underlying OAuth2 error that caused this error (if applicable).

                                          -
                                          code: string

                                          The error code associated with the custom token exchange error.

                                          -

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Constructors
                                          Properties
                                          +

                                          Returns CustomTokenExchangeError

                                          Properties

                                          cause?: OAuth2Error

                                          The underlying OAuth2 error that caused this error (if applicable).

                                          +
                                          code: string

                                          The error code associated with the custom token exchange error.

                                          +

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Constructors
                                          Properties
                                          diff --git a/docs/classes/errors.DPoPError.html b/docs/classes/errors.DPoPError.html index ef5ae281d..07da7222c 100644 --- a/docs/classes/errors.DPoPError.html +++ b/docs/classes/errors.DPoPError.html @@ -1,4 +1,4 @@ -DPoPError | @auth0/nextjs-auth0 - v4.17.1
                                          @auth0/nextjs-auth0 - v4.17.1
                                            Preparing search index...

                                            Class DPoPError

                                            Represents an error that occurred during DPoP (Demonstrating Proof-of-Possession) operations.

                                            +DPoPError | @auth0/nextjs-auth0 - v4.18.0
                                            @auth0/nextjs-auth0 - v4.18.0
                                              Preparing search index...

                                              Class DPoPError

                                              Represents an error that occurred during DPoP (Demonstrating Proof-of-Possession) operations.

                                              DPoP is an OAuth 2.0 extension that provides application-level proof-of-possession security by binding access tokens to cryptographic key pairs. This error is thrown when DPoP-related operations fail, such as key pair operations, proof generation, or configuration issues.

                                              @@ -16,7 +16,7 @@

                                              RFC 9449: OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)

                                              -

                                              Hierarchy (View Summary)

                                              Index

                                              Constructors

                                              constructor +

                                              Hierarchy (View Summary)

                                              Index

                                              Constructors

                                              constructor

                                              Properties

                                              cause? code

                                              Constructors

                                              • Constructs a new DPoPError instance.

                                                @@ -26,6 +26,6 @@

                                              Returns DPoPError

                                              const dpopError = new DPoPError(
                                                DPoPErrorCode.DPOP_KEY_EXPORT_FAILED,
                                                "Unable to export public key to JWK format",
                                                keyExportError
                                              );
                                              -

                                              Properties

                                              cause?: Error

                                              The underlying error that caused this DPoP error (optional)

                                              -
                                              code: DPoPErrorCode

                                              The specific DPoP error code indicating the type of failure

                                              -

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Constructors
                                              Properties
                                              +

                                              Properties

                                              cause?: Error

                                              The underlying error that caused this DPoP error (optional)

                                              +
                                              code: DPoPErrorCode

                                              The specific DPoP error code indicating the type of failure

                                              +

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Constructors
                                              Properties
                                              diff --git a/docs/classes/errors.DiscoveryError.html b/docs/classes/errors.DiscoveryError.html index aa53c0681..85501ab70 100644 --- a/docs/classes/errors.DiscoveryError.html +++ b/docs/classes/errors.DiscoveryError.html @@ -1,3 +1,3 @@ -DiscoveryError | @auth0/nextjs-auth0 - v4.17.1
                                              @auth0/nextjs-auth0 - v4.17.1
                                                Preparing search index...

                                                Class DiscoveryError

                                                Hierarchy (View Summary)

                                                Index

                                                Constructors

                                                constructor +DiscoveryError | @auth0/nextjs-auth0 - v4.18.0
                                                @auth0/nextjs-auth0 - v4.18.0
                                                  Preparing search index...

                                                  Class DiscoveryError

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

                                                  constructor

                                                  Properties

                                                  code -

                                                  Constructors

                                                  Properties

                                                  code: string = "discovery_error"

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Constructors
                                                  Properties
                                                  +

                                                  Constructors

                                                  Properties

                                                  code: string = "discovery_error"

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Constructors
                                                  Properties
                                                  diff --git a/docs/classes/errors.InvalidConfigurationError.html b/docs/classes/errors.InvalidConfigurationError.html index b5d8f9fe0..fa9845501 100644 --- a/docs/classes/errors.InvalidConfigurationError.html +++ b/docs/classes/errors.InvalidConfigurationError.html @@ -1,3 +1,3 @@ -InvalidConfigurationError | @auth0/nextjs-auth0 - v4.17.1
                                                  @auth0/nextjs-auth0 - v4.17.1
                                                    Preparing search index...

                                                    Class InvalidConfigurationError

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Constructors

                                                    constructor +InvalidConfigurationError | @auth0/nextjs-auth0 - v4.18.0
                                                    @auth0/nextjs-auth0 - v4.18.0
                                                      Preparing search index...

                                                      Class InvalidConfigurationError

                                                      Hierarchy (View Summary)

                                                      Index

                                                      Constructors

                                                      constructor

                                                      Properties

                                                      code -

                                                      Constructors

                                                      Properties

                                                      code: string = "invalid_configuration"

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Constructors
                                                      Properties
                                                      +

                                                      Constructors

                                                      Properties

                                                      code: string = "invalid_configuration"

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Constructors
                                                      Properties
                                                      diff --git a/docs/classes/errors.InvalidRequestError.html b/docs/classes/errors.InvalidRequestError.html index c301c88c3..4c61721d4 100644 --- a/docs/classes/errors.InvalidRequestError.html +++ b/docs/classes/errors.InvalidRequestError.html @@ -1,6 +1,6 @@ -InvalidRequestError | @auth0/nextjs-auth0 - v4.17.1
                                                      @auth0/nextjs-auth0 - v4.17.1
                                                        Preparing search index...

                                                        Class InvalidRequestError

                                                        Thrown when request validation fails (missing/invalid params). +InvalidRequestError | @auth0/nextjs-auth0 - v4.18.0

                                                        @auth0/nextjs-auth0 - v4.18.0
                                                          Preparing search index...

                                                          Class InvalidRequestError

                                                          Thrown when request validation fails (missing/invalid params). Mapped to 400 Bad Request.

                                                          -

                                                          Hierarchy (View Summary)

                                                          Index

                                                          Constructors

                                                          constructor +

                                                          Hierarchy (View Summary)

                                                          Index

                                                          Constructors

                                                          constructor

                                                          Properties

                                                          code

                                                          Methods

                                                          toJSON -

                                                          Constructors

                                                          Properties

                                                          code: string = "invalid_request"

                                                          Methods

                                                          • Returns { error: string; error_description: string }

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Constructors
                                                          Properties
                                                          Methods
                                                          +

                                                          Constructors

                                                          Properties

                                                          code: string = "invalid_request"

                                                          Methods

                                                          • Returns { error: string; error_description: string }

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Constructors
                                                          Properties
                                                          Methods
                                                          diff --git a/docs/classes/errors.InvalidStateError.html b/docs/classes/errors.InvalidStateError.html index 5fc77687a..887d06d90 100644 --- a/docs/classes/errors.InvalidStateError.html +++ b/docs/classes/errors.InvalidStateError.html @@ -1,3 +1,3 @@ -InvalidStateError | @auth0/nextjs-auth0 - v4.17.1
                                                          @auth0/nextjs-auth0 - v4.17.1
                                                            Preparing search index...

                                                            Class InvalidStateError

                                                            Hierarchy (View Summary)

                                                            Index

                                                            Constructors

                                                            constructor +InvalidStateError | @auth0/nextjs-auth0 - v4.18.0
                                                            @auth0/nextjs-auth0 - v4.18.0
                                                              Preparing search index...

                                                              Class InvalidStateError

                                                              Hierarchy (View Summary)

                                                              Index

                                                              Constructors

                                                              constructor

                                                              Properties

                                                              code -

                                                              Constructors

                                                              Properties

                                                              code: string = "invalid_state"

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Constructors
                                                              Properties
                                                              +

                                                              Constructors

                                                              Properties

                                                              code: string = "invalid_state"

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Constructors
                                                              Properties
                                                              diff --git a/docs/classes/errors.MfaChallengeError.html b/docs/classes/errors.MfaChallengeError.html index b886e9f42..c44b7aac3 100644 --- a/docs/classes/errors.MfaChallengeError.html +++ b/docs/classes/errors.MfaChallengeError.html @@ -1,14 +1,14 @@ -MfaChallengeError | @auth0/nextjs-auth0 - v4.17.1
                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                Preparing search index...

                                                                Class MfaChallengeError

                                                                Error thrown when initiating an MFA challenge fails.

                                                                +MfaChallengeError | @auth0/nextjs-auth0 - v4.18.0
                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                  Preparing search index...

                                                                  Class MfaChallengeError

                                                                  Error thrown when initiating an MFA challenge fails.

                                                                  try {
                                                                    await mfa.challenge({
                                                                      mfaToken,
                                                                      challengeType: 'oob',
                                                                      authenticatorId: 'sms|dev_abc123'
                                                                    });
                                                                  } catch (error) {
                                                                    if (error instanceof MfaChallengeError) {
                                                                      if (error.cause?.error === 'invalid_authenticator_id') {
                                                                        console.error('Authenticator not found or not active');
                                                                      }
                                                                    }
                                                                  }
                                                                  -

                                                                  Hierarchy

                                                                  • MfaError
                                                                    • MfaChallengeError
                                                                  Index

                                                                  Constructors

                                                                  constructor +

                                                                  Hierarchy

                                                                  • MfaError
                                                                    • MfaChallengeError
                                                                  Index

                                                                  Constructors

                                                                  constructor

                                                                  Properties

                                                                  cause? error error_description

                                                                  Accessors

                                                                  code

                                                                  Methods

                                                                  toJSON -

                                                                  Constructors

                                                                  Properties

                                                                  cause?: MfaApiErrorResponse
                                                                  error: string
                                                                  error_description: string

                                                                  Accessors

                                                                  Methods

                                                                  • Serialize error for HTTP responses. +

                                                                  Constructors

                                                                  Properties

                                                                  cause?: MfaApiErrorResponse
                                                                  error: string
                                                                  error_description: string

                                                                  Accessors

                                                                  Methods

                                                                  • Serialize error for HTTP responses. Called automatically by Response.json() and JSON.stringify(). Ensures both SDK and HTTP API consumers get identical shape.

                                                                    -

                                                                    Returns { error: string; error_description: string }

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Constructors
                                                                  Properties
                                                                  Accessors
                                                                  Methods
                                                                  +

                                                                  Returns { error: string; error_description: string }

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Constructors
                                                                  Properties
                                                                  Accessors
                                                                  Methods
                                                                  diff --git a/docs/classes/errors.MfaEnrollmentError.html b/docs/classes/errors.MfaEnrollmentError.html index ae8bff360..5d89a5810 100644 --- a/docs/classes/errors.MfaEnrollmentError.html +++ b/docs/classes/errors.MfaEnrollmentError.html @@ -1,14 +1,14 @@ -MfaEnrollmentError | @auth0/nextjs-auth0 - v4.17.1
                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                    Preparing search index...

                                                                    Class MfaEnrollmentError

                                                                    Error thrown when MFA enrollment fails.

                                                                    +MfaEnrollmentError | @auth0/nextjs-auth0 - v4.18.0
                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                      Preparing search index...

                                                                      Class MfaEnrollmentError

                                                                      Error thrown when MFA enrollment fails.

                                                                      try {
                                                                        await mfa.enroll({
                                                                          mfaToken,
                                                                          authenticatorTypes: ['otp']
                                                                        });
                                                                      } catch (error) {
                                                                        if (error instanceof MfaEnrollmentError) {
                                                                          if (error.cause?.error === 'unsupported_challenge_type') {
                                                                            console.error('Tenant does not support OTP enrollment');
                                                                          }
                                                                        }
                                                                      }
                                                                      -

                                                                      Hierarchy

                                                                      • MfaError
                                                                        • MfaEnrollmentError
                                                                      Index

                                                                      Constructors

                                                                      constructor +

                                                                      Hierarchy

                                                                      • MfaError
                                                                        • MfaEnrollmentError
                                                                      Index

                                                                      Constructors

                                                                      constructor

                                                                      Properties

                                                                      cause? error error_description

                                                                      Accessors

                                                                      code

                                                                      Methods

                                                                      toJSON -

                                                                      Constructors

                                                                      Properties

                                                                      cause?: MfaApiErrorResponse
                                                                      error: string
                                                                      error_description: string

                                                                      Accessors

                                                                      Methods

                                                                      • Serialize error for HTTP responses. +

                                                                      Constructors

                                                                      Properties

                                                                      cause?: MfaApiErrorResponse
                                                                      error: string
                                                                      error_description: string

                                                                      Accessors

                                                                      Methods

                                                                      • Serialize error for HTTP responses. Called automatically by Response.json() and JSON.stringify(). Ensures both SDK and HTTP API consumers get identical shape.

                                                                        -

                                                                        Returns { error: string; error_description: string }

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Constructors
                                                                      Properties
                                                                      Accessors
                                                                      Methods
                                                                      +

                                                                      Returns { error: string; error_description: string }

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Constructors
                                                                      Properties
                                                                      Accessors
                                                                      Methods
                                                                      diff --git a/docs/classes/errors.MfaGetAuthenticatorsError.html b/docs/classes/errors.MfaGetAuthenticatorsError.html index f92a249f4..e99218f61 100644 --- a/docs/classes/errors.MfaGetAuthenticatorsError.html +++ b/docs/classes/errors.MfaGetAuthenticatorsError.html @@ -1,14 +1,14 @@ -MfaGetAuthenticatorsError | @auth0/nextjs-auth0 - v4.17.1
                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                        Preparing search index...

                                                                        Class MfaGetAuthenticatorsError

                                                                        Error thrown when listing MFA authenticators fails.

                                                                        +MfaGetAuthenticatorsError | @auth0/nextjs-auth0 - v4.18.0
                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                          Preparing search index...

                                                                          Class MfaGetAuthenticatorsError

                                                                          Error thrown when listing MFA authenticators fails.

                                                                          try {
                                                                            const authenticators = await mfa.getAuthenticators({ mfaToken });
                                                                          } catch (error) {
                                                                            if (error instanceof MfaGetAuthenticatorsError) {
                                                                              console.error(error.code); // 'invalid_token', 'expired_token', etc.
                                                                              console.error(error.cause?.error_description);
                                                                            }
                                                                          }
                                                                          -

                                                                          Hierarchy

                                                                          • MfaError
                                                                            • MfaGetAuthenticatorsError
                                                                          Index

                                                                          Constructors

                                                                          constructor +

                                                                          Hierarchy

                                                                          • MfaError
                                                                            • MfaGetAuthenticatorsError
                                                                          Index

                                                                          Constructors

                                                                          constructor

                                                                          Properties

                                                                          cause? error error_description

                                                                          Accessors

                                                                          code

                                                                          Methods

                                                                          toJSON -

                                                                          Constructors

                                                                          Properties

                                                                          cause?: MfaApiErrorResponse
                                                                          error: string
                                                                          error_description: string

                                                                          Accessors

                                                                          Methods

                                                                          • Serialize error for HTTP responses. +

                                                                          Constructors

                                                                          Properties

                                                                          cause?: MfaApiErrorResponse
                                                                          error: string
                                                                          error_description: string

                                                                          Accessors

                                                                          Methods

                                                                          • Serialize error for HTTP responses. Called automatically by Response.json() and JSON.stringify(). Ensures both SDK and HTTP API consumers get identical shape.

                                                                            -

                                                                            Returns { error: string; error_description: string }

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Constructors
                                                                          Properties
                                                                          Accessors
                                                                          Methods
                                                                          +

                                                                          Returns { error: string; error_description: string }

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Constructors
                                                                          Properties
                                                                          Accessors
                                                                          Methods
                                                                          diff --git a/docs/classes/errors.MfaNoAvailableFactorsError.html b/docs/classes/errors.MfaNoAvailableFactorsError.html index 1f443d30c..c71f60e85 100644 --- a/docs/classes/errors.MfaNoAvailableFactorsError.html +++ b/docs/classes/errors.MfaNoAvailableFactorsError.html @@ -1,7 +1,7 @@ -MfaNoAvailableFactorsError | @auth0/nextjs-auth0 - v4.17.1
                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                            Preparing search index...

                                                                            Class MfaNoAvailableFactorsError

                                                                            Error thrown when no MFA factors are available for challenge. +MfaNoAvailableFactorsError | @auth0/nextjs-auth0 - v4.18.0

                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                              Preparing search index...

                                                                              Class MfaNoAvailableFactorsError

                                                                              Error thrown when no MFA factors are available for challenge. SDK-generated error (no Auth0 API equivalent).

                                                                              -

                                                                              Hierarchy (View Summary)

                                                                              Index

                                                                              Constructors

                                                                              constructor +

                                                                              Hierarchy (View Summary)

                                                                              Index

                                                                              Constructors

                                                                              constructor

                                                                              Properties

                                                                              code error error_description -

                                                                              Constructors

                                                                              Properties

                                                                              code: string = "mfa_no_available_factors"
                                                                              error: string = "mfa_no_available_factors"
                                                                              error_description: string

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Constructors
                                                                              Properties
                                                                              +

                                                                              Constructors

                                                                              Properties

                                                                              code: string = "mfa_no_available_factors"
                                                                              error: string = "mfa_no_available_factors"
                                                                              error_description: string

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Constructors
                                                                              Properties
                                                                              diff --git a/docs/classes/errors.MfaVerifyError.html b/docs/classes/errors.MfaVerifyError.html index a8545e5c3..40afdf146 100644 --- a/docs/classes/errors.MfaVerifyError.html +++ b/docs/classes/errors.MfaVerifyError.html @@ -1,14 +1,14 @@ -MfaVerifyError | @auth0/nextjs-auth0 - v4.17.1
                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                Preparing search index...

                                                                                Class MfaVerifyError

                                                                                Error thrown when MFA verification fails.

                                                                                +MfaVerifyError | @auth0/nextjs-auth0 - v4.18.0
                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                  Preparing search index...

                                                                                  Class MfaVerifyError

                                                                                  Error thrown when MFA verification fails.

                                                                                  try {
                                                                                    await mfa.verify({
                                                                                      mfaToken,
                                                                                      otp: '123456'
                                                                                    });
                                                                                  } catch (error) {
                                                                                    if (error instanceof MfaVerifyError) {
                                                                                      if (error.cause?.error === 'invalid_grant') {
                                                                                        console.error('Invalid or expired verification code');
                                                                                      }
                                                                                    }
                                                                                  }
                                                                                  -

                                                                                  Hierarchy

                                                                                  • MfaError
                                                                                    • MfaVerifyError
                                                                                  Index

                                                                                  Constructors

                                                                                  constructor +

                                                                                  Hierarchy

                                                                                  • MfaError
                                                                                    • MfaVerifyError
                                                                                  Index

                                                                                  Constructors

                                                                                  constructor

                                                                                  Properties

                                                                                  cause? error error_description

                                                                                  Accessors

                                                                                  code

                                                                                  Methods

                                                                                  toJSON -

                                                                                  Constructors

                                                                                  Properties

                                                                                  cause?: MfaApiErrorResponse
                                                                                  error: string
                                                                                  error_description: string

                                                                                  Accessors

                                                                                  Methods

                                                                                  • Serialize error for HTTP responses. +

                                                                                  Constructors

                                                                                  Properties

                                                                                  cause?: MfaApiErrorResponse
                                                                                  error: string
                                                                                  error_description: string

                                                                                  Accessors

                                                                                  Methods

                                                                                  • Serialize error for HTTP responses. Called automatically by Response.json() and JSON.stringify(). Ensures both SDK and HTTP API consumers get identical shape.

                                                                                    -

                                                                                    Returns { error: string; error_description: string }

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Constructors
                                                                                  Properties
                                                                                  Accessors
                                                                                  Methods
                                                                                  +

                                                                                  Returns { error: string; error_description: string }

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Constructors
                                                                                  Properties
                                                                                  Accessors
                                                                                  Methods
                                                                                  diff --git a/docs/classes/errors.MissingStateError.html b/docs/classes/errors.MissingStateError.html index 0088fc07e..4517d7f07 100644 --- a/docs/classes/errors.MissingStateError.html +++ b/docs/classes/errors.MissingStateError.html @@ -1,3 +1,3 @@ -MissingStateError | @auth0/nextjs-auth0 - v4.17.1
                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                    Preparing search index...

                                                                                    Class MissingStateError

                                                                                    Hierarchy (View Summary)

                                                                                    Index

                                                                                    Constructors

                                                                                    constructor +MissingStateError | @auth0/nextjs-auth0 - v4.18.0
                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                      Preparing search index...

                                                                                      Class MissingStateError

                                                                                      Hierarchy (View Summary)

                                                                                      Index

                                                                                      Constructors

                                                                                      constructor

                                                                                      Properties

                                                                                      code -

                                                                                      Constructors

                                                                                      Properties

                                                                                      code: string = "missing_state"

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Constructors
                                                                                      Properties
                                                                                      +

                                                                                      Constructors

                                                                                      Properties

                                                                                      code: string = "missing_state"

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Constructors
                                                                                      Properties
                                                                                      diff --git a/docs/classes/errors.MyAccountApiError.html b/docs/classes/errors.MyAccountApiError.html index 2a8002c34..c58d9f6a9 100644 --- a/docs/classes/errors.MyAccountApiError.html +++ b/docs/classes/errors.MyAccountApiError.html @@ -1,5 +1,5 @@ -MyAccountApiError | @auth0/nextjs-auth0 - v4.17.1
                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                        Preparing search index...

                                                                                        Class MyAccountApiError

                                                                                        Error class representing a connect account request error.

                                                                                        -

                                                                                        Hierarchy (View Summary)

                                                                                        Index

                                                                                        Constructors

                                                                                        constructor +MyAccountApiError | @auth0/nextjs-auth0 - v4.18.0
                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                          Preparing search index...

                                                                                          Class MyAccountApiError

                                                                                          Error class representing a connect account request error.

                                                                                          +

                                                                                          Hierarchy (View Summary)

                                                                                          Index

                                                                                          Constructors

                                                                                          constructor

                                                                                          Properties

                                                                                          code detail name @@ -7,8 +7,8 @@ title type validationErrors? -

                                                                                          Constructors

                                                                                          • Parameters

                                                                                            • __namedParameters: {
                                                                                                  detail: string;
                                                                                                  status: number;
                                                                                                  title: string;
                                                                                                  type: string;
                                                                                                  validationErrors?: {
                                                                                                      detail: string;
                                                                                                      field?: string;
                                                                                                      pointer?: string;
                                                                                                      source?: string;
                                                                                                  }[];
                                                                                              }

                                                                                            Returns MyAccountApiError

                                                                                          Properties

                                                                                          code: string = "my_account_api_error"
                                                                                          detail: string
                                                                                          name: string = "MyAccountApiError"
                                                                                          status: number
                                                                                          title: string
                                                                                          type: string
                                                                                          validationErrors?: {
                                                                                              detail: string;
                                                                                              field?: string;
                                                                                              pointer?: string;
                                                                                              source?: string;
                                                                                          }[]

                                                                                          Type Declaration

                                                                                          • detail: string

                                                                                            A human-readable description of the specific error. Required.

                                                                                            +

                                                                                          Constructors

                                                                                          • Parameters

                                                                                            • __namedParameters: {
                                                                                                  detail: string;
                                                                                                  status: number;
                                                                                                  title: string;
                                                                                                  type: string;
                                                                                                  validationErrors?: {
                                                                                                      detail: string;
                                                                                                      field?: string;
                                                                                                      pointer?: string;
                                                                                                      source?: string;
                                                                                                  }[];
                                                                                              }

                                                                                            Returns MyAccountApiError

                                                                                          Properties

                                                                                          code: string = "my_account_api_error"
                                                                                          detail: string
                                                                                          name: string = "MyAccountApiError"
                                                                                          status: number
                                                                                          title: string
                                                                                          type: string
                                                                                          validationErrors?: {
                                                                                              detail: string;
                                                                                              field?: string;
                                                                                              pointer?: string;
                                                                                              source?: string;
                                                                                          }[]

                                                                                          Type Declaration

                                                                                          • detail: string

                                                                                            A human-readable description of the specific error. Required.

                                                                                          • Optionalfield?: string

                                                                                            The name of the invalid parameter. Optional.

                                                                                          • Optionalpointer?: string

                                                                                            A JSON Pointer that points to the exact location of the error in a JSON document being validated. Optional.

                                                                                          • Optionalsource?: string

                                                                                            Specifies the source of the error (e.g., body, query, or header in an HTML message). Optional.

                                                                                            -

                                                                                          Settings

                                                                                          Member Visibility

                                                                                          On This Page

                                                                                          Constructors
                                                                                          Properties
                                                                                          +

                                                                                          Settings

                                                                                          Member Visibility

                                                                                          On This Page

                                                                                          Constructors
                                                                                          Properties
                                                                                          diff --git a/docs/classes/errors.OAuth2Error.html b/docs/classes/errors.OAuth2Error.html index fb753f8d0..f1398f7a1 100644 --- a/docs/classes/errors.OAuth2Error.html +++ b/docs/classes/errors.OAuth2Error.html @@ -1,5 +1,5 @@ -OAuth2Error | @auth0/nextjs-auth0 - v4.17.1
                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                            Preparing search index...

                                                                                            Class OAuth2Error

                                                                                            Errors that come from Auth0 in the redirect_uri callback may contain reflected user input via the OpenID Connect error and error_description query parameter. +OAuth2Error | @auth0/nextjs-auth0 - v4.18.0

                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                              Preparing search index...

                                                                                              Class OAuth2Error

                                                                                              Errors that come from Auth0 in the redirect_uri callback may contain reflected user input via the OpenID Connect error and error_description query parameter. You should not render the error message, or error and error_description properties without properly escaping them first.

                                                                                              -

                                                                                              Hierarchy (View Summary)

                                                                                              Index

                                                                                              Constructors

                                                                                              constructor +

                                                                                              Hierarchy (View Summary)

                                                                                              Index

                                                                                              Constructors

                                                                                              constructor

                                                                                              Properties

                                                                                              code -

                                                                                              Constructors

                                                                                              Properties

                                                                                              code: string

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Constructors
                                                                                              Properties
                                                                                              +

                                                                                              Constructors

                                                                                              Properties

                                                                                              code: string

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Constructors
                                                                                              Properties
                                                                                              diff --git a/docs/classes/errors.SdkError.html b/docs/classes/errors.SdkError.html index 9425a02ec..97b55b89a 100644 --- a/docs/classes/errors.SdkError.html +++ b/docs/classes/errors.SdkError.html @@ -1,3 +1,3 @@ -SdkError | @auth0/nextjs-auth0 - v4.17.1
                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                Preparing search index...

                                                                                                Class SdkErrorAbstract

                                                                                                Hierarchy (View Summary)

                                                                                                Index

                                                                                                Constructors

                                                                                                constructor +SdkError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                  Preparing search index...

                                                                                                  Class SdkErrorAbstract

                                                                                                  Hierarchy (View Summary)

                                                                                                  Index

                                                                                                  Constructors

                                                                                                  constructor

                                                                                                  Properties

                                                                                                  code -

                                                                                                  Constructors

                                                                                                  • Parameters

                                                                                                    • Optionalmessage: string

                                                                                                    Returns SdkError

                                                                                                  Properties

                                                                                                  code: string

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Constructors
                                                                                                  Properties
                                                                                                  +

                                                                                                  Constructors

                                                                                                  • Parameters

                                                                                                    • Optionalmessage: string

                                                                                                    Returns SdkError

                                                                                                  Properties

                                                                                                  code: string

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Constructors
                                                                                                  Properties
                                                                                                  diff --git a/docs/classes/server.AbstractSessionStore.html b/docs/classes/server.AbstractSessionStore.html index eee6b1a9c..664610a81 100644 --- a/docs/classes/server.AbstractSessionStore.html +++ b/docs/classes/server.AbstractSessionStore.html @@ -1,4 +1,4 @@ -AbstractSessionStore | @auth0/nextjs-auth0 - v4.17.1
                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                    Preparing search index...

                                                                                                    Class AbstractSessionStoreAbstract

                                                                                                    Index

                                                                                                    Constructors

                                                                                                    constructor +AbstractSessionStore | @auth0/nextjs-auth0 - v4.18.0
                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                      Preparing search index...

                                                                                                      Class AbstractSessionStoreAbstract

                                                                                                      Index

                                                                                                      Constructors

                                                                                                      constructor

                                                                                                      Properties

                                                                                                      cookieConfig rolling secret @@ -10,9 +10,9 @@ epoch get set -

                                                                                                      Constructors

                                                                                                      Properties

                                                                                                      cookieConfig: CookieOptions
                                                                                                      rolling: boolean
                                                                                                      secret: string
                                                                                                      sessionCookieName: string
                                                                                                      store?: SessionDataStore

                                                                                                      Accessors

                                                                                                      Methods

                                                                                                      • calculateMaxAge calculates the max age of the session based on createdAt and the rolling and absolute durations.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        • createdAt: number

                                                                                                        Returns number

                                                                                                      • save adds the encrypted session cookie as a Set-Cookie header. If the iat property +

                                                                                                      Constructors

                                                                                                      Properties

                                                                                                      cookieConfig: CookieOptions
                                                                                                      rolling: boolean
                                                                                                      secret: string
                                                                                                      sessionCookieName: string
                                                                                                      store?: SessionDataStore

                                                                                                      Accessors

                                                                                                      Methods

                                                                                                      • calculateMaxAge calculates the max age of the session based on createdAt and the rolling and absolute durations.

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • createdAt: number

                                                                                                        Returns number

                                                                                                      • save adds the encrypted session cookie as a Set-Cookie header. If the iat property is present on the session, then it will be used to compute the maxAge cookie value.

                                                                                                        -

                                                                                                        Parameters

                                                                                                        Returns Promise<void>

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Constructors
                                                                                                      Properties
                                                                                                      Accessors
                                                                                                      Methods
                                                                                                      +

                                                                                                      Parameters

                                                                                                      Returns Promise<void>

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Constructors
                                                                                                      Properties
                                                                                                      Accessors
                                                                                                      Methods
                                                                                                      diff --git a/docs/classes/server.Auth0Client.html b/docs/classes/server.Auth0Client.html index 800093655..ac4ad51e4 100644 --- a/docs/classes/server.Auth0Client.html +++ b/docs/classes/server.Auth0Client.html @@ -1,4 +1,4 @@ -Auth0Client | @auth0/nextjs-auth0 - v4.17.1
                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                        Preparing search index...

                                                                                                        Class Auth0Client

                                                                                                        Index

                                                                                                        Constructors

                                                                                                        constructor +Auth0Client | @auth0/nextjs-auth0 - v4.18.0
                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                          Preparing search index...

                                                                                                          Class Auth0Client

                                                                                                          Index

                                                                                                          Constructors

                                                                                                          constructor

                                                                                                          Accessors

                                                                                                          mfa

                                                                                                          Methods

                                                                                                          connectAccount createFetcher @@ -12,7 +12,7 @@ updateSession withApiAuthRequired withPageAuthRequired -

                                                                                                          Constructors

                                                                                                          Accessors

                                                                                                          • get mfa(): ServerMfaClient

                                                                                                            MFA API for server-side operations.

                                                                                                            +

                                                                                                          Constructors

                                                                                                          Accessors

                                                                                                          • get mfa(): ServerMfaClient

                                                                                                            MFA API for server-side operations.

                                                                                                            Provides access to MFA methods that require encrypted mfa_token from MfaRequiredError:

                                                                                                            • getAuthenticators: List enrolled MFA factors
                                                                                                              • @@ -22,13 +22,13 @@

                                                                                                            Returns ServerMfaClient

                                                                                                            try {
                                                                                                              const { token } = await auth0.getAccessToken({ audience: 'https://api.example.com' });
                                                                                                            } catch (error) {
                                                                                                              if (error instanceof MfaRequiredError) {
                                                                                                                // Get available authenticators
                                                                                                                const authenticators = await auth0.mfa.getAuthenticators({
                                                                                                                  mfaToken: error.mfa_token
                                                                                                                });

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

                                                                                                                // Verify code
                                                                                                                const tokens = await auth0.mfa.verify({
                                                                                                                  mfaToken: error.mfa_token,
                                                                                                                  otp: '123456'
                                                                                                                });
                                                                                                              }
                                                                                                            }
                                                                                                            -

                                                                                                          Methods

                                                                                                          Methods

                                                                                                          • Initiates the Connect Account flow to connect a third-party account to the user's profile. If the user does not have an active session, a ConnectAccountError is thrown.

                                                                                                            This method first attempts to obtain an access token with the create:me:connected_accounts scope for the My Account API to create a connected account for the user.

                                                                                                            The user will then be redirected to authorize the connection with the third-party provider.

                                                                                                            You must enable Offline Access from the Connection Permissions settings to be able to use the connection with Connected Accounts.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            Returns Promise<NextResponse<unknown>>

                                                                                                          • Creates a configured Fetcher instance for making authenticated API requests.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            Returns Promise<NextResponse<unknown>>

                                                                                                          • Creates a configured Fetcher instance for making authenticated API requests.

                                                                                                            This method creates a specialized HTTP client that handles:

                                                                                                            • Automatic access token retrieval and injection
                                                                                                              • @@ -55,7 +55,7 @@
                                                                                                            • Fetcher for details on using the returned fetcher instance
                                                                                                            • FetcherMinimalConfig for available configuration options
                                                                                                            -

                                                                                                          • Exchanges an external token for Auth0 tokens using Custom Token Exchange (RFC 8693).

                                                                                                            This is a server-only method that does NOT modify the session. The returned tokens can be used independently or stored by the developer.

                                                                                                            Note: CTE tokens are not cached. The caller is responsible for token storage if needed.

                                                                                                            @@ -67,11 +67,11 @@

                                                                                                            Auth0 CTE Documentation

                                                                                                            -

                                                                                                          • Parameters

                                                                                                          • Parameters

                                                                                                            • Optionaloptions: GetAccessTokenOptions

                                                                                                              Optional configuration for getting the access token.

                                                                                                              • Optionalaudience?: string | null

                                                                                                                Please note: If you are passing audience, ensure that the used audiences and scopes are part of the Application's Refresh Token Policies in Auth0 when configuring Multi-Resource Refresh Tokens (MRRT). Auth0 Documentation on Multi-resource Refresh Tokens

                                                                                                                -
                                                                                                              • Optionalrefresh?: boolean | null
                                                                                                              • Optionalscope?: string | null

                                                                                                            Returns Promise<
                                                                                                                {
                                                                                                                    audience?: string;
                                                                                                                    expiresAt: number;
                                                                                                                    scope?: string;
                                                                                                                    token: string;
                                                                                                                    token_type?: string;
                                                                                                                },
                                                                                                            >

                                                                                                          • getAccessToken returns the access token.

                                                                                                            +
                                                                                                          • Optionalrefresh?: boolean | null
                                                                                                          • Optionalscope?: string | null

                                                                                                          Returns Promise<
                                                                                                              {
                                                                                                                  audience?: string;
                                                                                                                  expiresAt: number;
                                                                                                                  scope?: string;
                                                                                                                  token: string;
                                                                                                                  token_type?: string;
                                                                                                              },
                                                                                                          >

                                                                                                        • getAccessToken returns the access token.

                                                                                                          This method can be used in middleware and getServerSideProps, API routes in the Pages Router.

                                                                                                          Parameters

                                                                                                          • req: NextRequest | PagesRouterRequest

                                                                                                            The request object.

                                                                                                          • res: NextResponse<unknown> | PagesRouterResponse

                                                                                                            The response object.

                                                                                                            @@ -79,23 +79,23 @@
                                                                                                            • Optionalaudience?: string | null

                                                                                                              Please note: If you are passing audience, ensure that the used audiences and scopes are part of the Application's Refresh Token Policies in Auth0 when configuring Multi-Resource Refresh Tokens (MRRT). Auth0 Documentation on Multi-resource Refresh Tokens

                                                                                                              -
                                                                                                            • Optionalrefresh?: boolean | null
                                                                                                            • Optionalscope?: string | null

                                                                                                          Returns Promise<
                                                                                                              {
                                                                                                                  audience?: string;
                                                                                                                  expiresAt: number;
                                                                                                                  scope?: string;
                                                                                                                  token: string;
                                                                                                                  token_type?: string;
                                                                                                              },
                                                                                                          >

                                                                                                          • Retrieves an access token for a connection.

                                                                                                            +
                                                                                                          • Optionalrefresh?: boolean | null
                                                                                                          • Optionalscope?: string | null

                                                                                                          Returns Promise<
                                                                                                              {
                                                                                                                  audience?: string;
                                                                                                                  expiresAt: number;
                                                                                                                  scope?: string;
                                                                                                                  token: string;
                                                                                                                  token_type?: string;
                                                                                                              },
                                                                                                          >

                                                                                                          • Retrieves an access token for a connection.

                                                                                                            This method can be used in Server Components, Server Actions, and Route Handlers in the App Router.

                                                                                                            NOTE: Server Components cannot set cookies. Calling getAccessTokenForConnection() in a Server Component will cause the access token to be refreshed, if it is expired, and the updated token set will not to be persisted. It is recommended to call getAccessTokenForConnection(req, res) in the middleware if you need to retrieve the access token in a Server Component to ensure the updated token set is persisted.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            Returns Promise<{ expiresAt: number; token: string }>

                                                                                                          • Retrieves an access token for a connection.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            Returns Promise<{ expiresAt: number; token: string }>

                                                                                                          • Retrieves an access token for a connection.

                                                                                                            This method can be used in middleware and getServerSideProps, API routes in the Pages Router.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            Returns Promise<{ expiresAt: number; token: string }>

                                                                                                          • middleware mounts the SDK routes to run as a middleware function.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            • req: NextRequest | Request

                                                                                                            Returns Promise<NextResponse<unknown>>

                                                                                                          • updateSession updates the session of the currently authenticated user. If the user does not have a session, an error is thrown.

                                                                                                            +

                                                                                                          • middleware mounts the SDK routes to run as a middleware function.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • req: NextRequest | Request

                                                                                                            Returns Promise<NextResponse<unknown>>

                                                                                                          • updateSession updates the session of the currently authenticated user. If the user does not have a session, an error is thrown.

                                                                                                            This method can be used in middleware and getServerSideProps, API routes, and middleware in the Pages Router.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            Returns Promise<void>

                                                                                                          • updateSession updates the session of the currently authenticated user. If the user does not have a session, an error is thrown.

                                                                                                            +

                                                                                                            Parameters

                                                                                                            Returns Promise<void>

                                                                                                          • updateSession updates the session of the currently authenticated user. If the user does not have a session, an error is thrown.

                                                                                                            This method can be used in Server Actions and Route Handlers in the App Router.

                                                                                                            -

                                                                                                            Parameters

                                                                                                            Returns Promise<void>

                                                                                                          • Parameters

                                                                                                            • apiRoute: AppRouteHandlerFn | NextApiHandler

                                                                                                            Returns (
                                                                                                                req: NextApiRequest | NextRequest,
                                                                                                                resOrParams: AppRouteHandlerFnContext | NextApiResponse,
                                                                                                            ) => unknown

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Constructors
                                                                                                          Accessors
                                                                                                          Methods
                                                                                                          +

                                                                                                          Parameters

                                                                                                          Returns Promise<void>

                                                                                                          • Parameters

                                                                                                            • apiRoute: AppRouteHandlerFn | NextApiHandler

                                                                                                            Returns (
                                                                                                                req: NextApiRequest | NextRequest,
                                                                                                                resOrParams: AppRouteHandlerFnContext | NextApiResponse,
                                                                                                            ) => unknown

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Constructors
                                                                                                          Accessors
                                                                                                          Methods
                                                                                                          diff --git a/docs/classes/server.DomainResolutionError.html b/docs/classes/server.DomainResolutionError.html index 4c8e0ece1..2f3c7ec7f 100644 --- a/docs/classes/server.DomainResolutionError.html +++ b/docs/classes/server.DomainResolutionError.html @@ -1,10 +1,10 @@ -DomainResolutionError | @auth0/nextjs-auth0 - v4.17.1
                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                            Preparing search index...

                                                                                                            Class DomainResolutionError

                                                                                                            Error thrown when domain resolution fails during MCD initialization or request handling.

                                                                                                            +DomainResolutionError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                              Preparing search index...

                                                                                                              Class DomainResolutionError

                                                                                                              Error thrown when domain resolution fails during MCD initialization or request handling.

                                                                                                              This error is public and may be caught by application code.

                                                                                                              -

                                                                                                              Hierarchy (View Summary)

                                                                                                              Index

                                                                                                              Constructors

                                                                                                              constructor +

                                                                                                              Hierarchy (View Summary)

                                                                                                              Index

                                                                                                              Constructors

                                                                                                              constructor

                                                                                                              Properties

                                                                                                              cause? code

                                                                                                              Constructors

                                                                                                              Properties

                                                                                                              cause?: Error

                                                                                                              The underlying error that caused the resolution failure (optional)

                                                                                                              -
                                                                                                              code: string = "domain_resolution_error"

                                                                                                              Settings

                                                                                                              Member Visibility

                                                                                                              On This Page

                                                                                                              Constructors
                                                                                                              Properties
                                                                                                              +

                                                                                                              Returns DomainResolutionError

                                                                                                              Properties

                                                                                                              cause?: Error

                                                                                                              The underlying error that caused the resolution failure (optional)

                                                                                                              +
                                                                                                              code: string = "domain_resolution_error"

                                                                                                              Settings

                                                                                                              Member Visibility

                                                                                                              On This Page

                                                                                                              Constructors
                                                                                                              Properties
                                                                                                              diff --git a/docs/classes/server.DomainValidationError.html b/docs/classes/server.DomainValidationError.html index 04cdd24e7..5bce74540 100644 --- a/docs/classes/server.DomainValidationError.html +++ b/docs/classes/server.DomainValidationError.html @@ -1,8 +1,8 @@ -DomainValidationError | @auth0/nextjs-auth0 - v4.17.1
                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                Preparing search index...

                                                                                                                Class DomainValidationError

                                                                                                                Error thrown when a domain hostname fails validation.

                                                                                                                +DomainValidationError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                  Preparing search index...

                                                                                                                  Class DomainValidationError

                                                                                                                  Error thrown when a domain hostname fails validation.

                                                                                                                  This includes rejection of IP addresses, localhost, .local domains, paths, and ports. This error is public and may be caught by application code.

                                                                                                                  -

                                                                                                                  Hierarchy (View Summary)

                                                                                                                  Index

                                                                                                                  Constructors

                                                                                                                  constructor +

                                                                                                                  Hierarchy (View Summary)

                                                                                                                  Index

                                                                                                                  Constructors

                                                                                                                  constructor

                                                                                                                  Properties

                                                                                                                  code

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  code: string = "domain_validation_error"

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  On This Page

                                                                                                                  Constructors
                                                                                                                  Properties
                                                                                                                  +

                                                                                                                  Returns DomainValidationError

                                                                                                                  Properties

                                                                                                                  code: string = "domain_validation_error"

                                                                                                                  Settings

                                                                                                                  Member Visibility

                                                                                                                  On This Page

                                                                                                                  Constructors
                                                                                                                  Properties
                                                                                                                  diff --git a/docs/classes/server.IssuerValidationError.html b/docs/classes/server.IssuerValidationError.html index 6f875c87f..0ac9bc8d4 100644 --- a/docs/classes/server.IssuerValidationError.html +++ b/docs/classes/server.IssuerValidationError.html @@ -1,12 +1,12 @@ -IssuerValidationError | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                    Preparing search index...

                                                                                                                    Class IssuerValidationError

                                                                                                                    Error thrown when the issuer URL is invalid or cannot be resolved.

                                                                                                                    +IssuerValidationError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                      Preparing search index...

                                                                                                                      Class IssuerValidationError

                                                                                                                      Error thrown when the issuer URL is invalid or cannot be resolved.

                                                                                                                      This error is public and may be caught by application code.

                                                                                                                      -

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      Index

                                                                                                                      Constructors

                                                                                                                      constructor +

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      Index

                                                                                                                      Constructors

                                                                                                                      constructor

                                                                                                                      Properties

                                                                                                                      actualIssuer code expectedIssuer

                                                                                                                      Constructors

                                                                                                                      Properties

                                                                                                                      actualIssuer: string

                                                                                                                      The actual issuer URL from the token

                                                                                                                      -
                                                                                                                      code: string = "issuer_validation_error"
                                                                                                                      expectedIssuer: string

                                                                                                                      The expected issuer URL

                                                                                                                      -

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      On This Page

                                                                                                                      Constructors
                                                                                                                      Properties
                                                                                                                      +

                                                                                                                      Returns IssuerValidationError

                                                                                                                      Properties

                                                                                                                      actualIssuer: string

                                                                                                                      The actual issuer URL from the token

                                                                                                                      +
                                                                                                                      code: string = "issuer_validation_error"
                                                                                                                      expectedIssuer: string

                                                                                                                      The expected issuer URL

                                                                                                                      +

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      On This Page

                                                                                                                      Constructors
                                                                                                                      Properties
                                                                                                                      diff --git a/docs/classes/server.MfaRequiredError.html b/docs/classes/server.MfaRequiredError.html index 7c38a0ba0..505b23a9c 100644 --- a/docs/classes/server.MfaRequiredError.html +++ b/docs/classes/server.MfaRequiredError.html @@ -1,4 +1,4 @@ -MfaRequiredError | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                        Preparing search index...

                                                                                                                        Class MfaRequiredError

                                                                                                                        Thrown when getAccessToken requires MFA step-up authentication.

                                                                                                                        +MfaRequiredError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                          Preparing search index...

                                                                                                                          Class MfaRequiredError

                                                                                                                          Thrown when getAccessToken requires MFA step-up authentication.

                                                                                                                          This error is thrown during token refresh when Auth0 returns mfa_required. The mfa_token property contains an encrypted token that can be used with Auth0's MFA API to complete the authentication challenge.

                                                                                                                          @@ -13,7 +13,7 @@

                                                                                                                          Auth0 MFA API

                                                                                                                          -

                                                                                                                          Hierarchy (View Summary)

                                                                                                                          Index

                                                                                                                          Constructors

                                                                                                                          constructor +

                                                                                                                          Hierarchy (View Summary)

                                                                                                                          Index

                                                                                                                          Constructors

                                                                                                                          constructor

                                                                                                                          Properties

                                                                                                                          cause? code error @@ -28,11 +28,11 @@

                                                                                                                          Returns MfaRequiredError

                                                                                                                          Constructor parameters use camelCase (mfaToken, mfaRequirements) for consistency with SDK conventions, but they are assigned to snake_case properties (mfa_token, mfa_requirements) to match Auth0 API response format.

                                                                                                                          -

                                                                                                                          Properties

                                                                                                                          cause?: Error
                                                                                                                          code: string = "mfa_required"
                                                                                                                          error: string = "mfa_required"

                                                                                                                          Original Auth0 error code

                                                                                                                          -
                                                                                                                          error_description: string

                                                                                                                          Original Auth0 error description

                                                                                                                          -
                                                                                                                          mfa_requirements?: MfaRequirements

                                                                                                                          MFA requirements indicating available challenge/enrollment methods

                                                                                                                          -
                                                                                                                          mfa_token: string

                                                                                                                          Encrypted MFA token to pass to MFA API methods.

                                                                                                                          -

                                                                                                                          Methods

                                                                                                                          Properties

                                                                                                                          cause?: Error
                                                                                                                          code: string = "mfa_required"
                                                                                                                          error: string = "mfa_required"

                                                                                                                          Original Auth0 error code

                                                                                                                          +
                                                                                                                          error_description: string

                                                                                                                          Original Auth0 error description

                                                                                                                          +
                                                                                                                          mfa_requirements?: MfaRequirements

                                                                                                                          MFA requirements indicating available challenge/enrollment methods

                                                                                                                          +
                                                                                                                          mfa_token: string

                                                                                                                          Encrypted MFA token to pass to MFA API methods.

                                                                                                                          +

                                                                                                                          Methods

                                                                                                                          • Serialize error for HTTP responses. Called automatically by Response.json() and JSON.stringify(). Ensures both SDK and HTTP API consumers get identical shape.

                                                                                                                            -

                                                                                                                            Returns {
                                                                                                                                error: string;
                                                                                                                                error_description: string;
                                                                                                                                mfa_requirements?: MfaRequirements;
                                                                                                                                mfa_token: string;
                                                                                                                            }

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Constructors
                                                                                                                          Properties
                                                                                                                          Methods
                                                                                                                          +

                                                                                                                          Returns {
                                                                                                                              error: string;
                                                                                                                              error_description: string;
                                                                                                                              mfa_requirements?: MfaRequirements;
                                                                                                                              mfa_token: string;
                                                                                                                          }

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Constructors
                                                                                                                          Properties
                                                                                                                          Methods
                                                                                                                          diff --git a/docs/classes/server.MfaTokenExpiredError.html b/docs/classes/server.MfaTokenExpiredError.html index cc22dabf7..afdcbd511 100644 --- a/docs/classes/server.MfaTokenExpiredError.html +++ b/docs/classes/server.MfaTokenExpiredError.html @@ -1,4 +1,4 @@ -MfaTokenExpiredError | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                            Preparing search index...

                                                                                                                            Class MfaTokenExpiredError

                                                                                                                            Thrown when MFA API methods are called but no context exists in session +MfaTokenExpiredError | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                              Preparing search index...

                                                                                                                              Class MfaTokenExpiredError

                                                                                                                              Thrown when MFA API methods are called but no context exists in session for the provided encrypted mfa_token.

                                                                                                                              This typically occurs when:

                                                                                                                                @@ -9,6 +9,6 @@ 
                                                                                                                              try {
                                                                                                                                await auth0.completeMfaChallenge(mfaToken, code);
                                                                                                                              } catch (error) {
                                                                                                                                if (error instanceof MfaTokenNotFoundError) {
                                                                                                                                  // Restart MFA flow - context was lost
                                                                                                                                  redirect("/auth/login?prompt=mfa");
                                                                                                                                }
                                                                                                                              }
                                                                                                                              -

                                                                                                                              Hierarchy (View Summary)

                                                                                                                              Index

                                                                                                                              Constructors

                                                                                                                              constructor +

                                                                                                                              Hierarchy (View Summary)

                                                                                                                              Index

                                                                                                                              Constructors

                                                                                                                              constructor

                                                                                                                              Properties

                                                                                                                              code -

                                                                                                                              Constructors

                                                                                                                              Properties

                                                                                                                              code: string = "mfa_token_expired"

                                                                                                                              Settings

                                                                                                                              Member Visibility

                                                                                                                              On This Page

                                                                                                                              Constructors
                                                                                                                              Properties
                                                                                                                              +

                                                                                                                              Constructors

                                                                                                                              Properties

                                                                                                                              code: string = "mfa_token_expired"

                                                                                                                              Settings

                                                                                                                              Member Visibility

                                                                                                                              On This Page

                                                                                                                              Constructors
                                                                                                                              Properties
                                                                                                                              diff --git a/docs/classes/server.MfaTokenInvalidError.html b/docs/classes/server.MfaTokenInvalidError.html index 409d8edd5..c54581ac3 100644 --- a/docs/classes/server.MfaTokenInvalidError.html +++ b/docs/classes/server.MfaTokenInvalidError.html @@ -1,10 +1,10 @@ -MfaTokenInvalidError | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                Preparing search index...

                                                                                                                                Class MfaTokenInvalidError

                                                                                                                                Thrown when the encrypted mfa_token is invalid.

                                                                                                                                +MfaTokenInvalidError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                  Preparing search index...

                                                                                                                                  Class MfaTokenInvalidError

                                                                                                                                  Thrown when the encrypted mfa_token is invalid.

                                                                                                                                  This occurs when:

                                                                                                                                  • The token was tampered with
                                                                                                                                  • The token is malformed (not valid JWE)
                                                                                                                                  • The token was encrypted with a different secret
                                                                                                                                  -

                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                  Index

                                                                                                                                  Constructors

                                                                                                                                  constructor +

                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                  Index

                                                                                                                                  Constructors

                                                                                                                                  constructor

                                                                                                                                  Properties

                                                                                                                                  code -

                                                                                                                                  Constructors

                                                                                                                                  Properties

                                                                                                                                  code: string = "mfa_token_invalid"

                                                                                                                                  Settings

                                                                                                                                  Member Visibility

                                                                                                                                  On This Page

                                                                                                                                  Constructors
                                                                                                                                  Properties
                                                                                                                                  +

                                                                                                                                  Constructors

                                                                                                                                  Properties

                                                                                                                                  code: string = "mfa_token_invalid"

                                                                                                                                  Settings

                                                                                                                                  Member Visibility

                                                                                                                                  On This Page

                                                                                                                                  Constructors
                                                                                                                                  Properties
                                                                                                                                  diff --git a/docs/classes/server.SessionDomainMismatchError.html b/docs/classes/server.SessionDomainMismatchError.html index 672665e99..e5dfd6e6a 100644 --- a/docs/classes/server.SessionDomainMismatchError.html +++ b/docs/classes/server.SessionDomainMismatchError.html @@ -1,8 +1,8 @@ -SessionDomainMismatchError | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                    Preparing search index...

                                                                                                                                    Class SessionDomainMismatchError

                                                                                                                                    Error thrown when a session's domain does not match the current request domain.

                                                                                                                                    +SessionDomainMismatchError | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                      Preparing search index...

                                                                                                                                      Class SessionDomainMismatchError

                                                                                                                                      Error thrown when a session's domain does not match the current request domain.

                                                                                                                                      This indicates a potential security issue where a user is attempting to use a session created for a different domain.

                                                                                                                                      -

                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                      Index

                                                                                                                                      Constructors

                                                                                                                                      constructor +

                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                      Index

                                                                                                                                      Constructors

                                                                                                                                      constructor

                                                                                                                                      Properties

                                                                                                                                      code

                                                                                                                                      Constructors

                                                                                                                                      Properties

                                                                                                                                      code: string = "session_domain_mismatch"

                                                                                                                                      Settings

                                                                                                                                      Member Visibility

                                                                                                                                      On This Page

                                                                                                                                      Constructors
                                                                                                                                      Properties
                                                                                                                                      +

                                                                                                                                      Returns SessionDomainMismatchError

                                                                                                                                      Properties

                                                                                                                                      code: string = "session_domain_mismatch"

                                                                                                                                      Settings

                                                                                                                                      Member Visibility

                                                                                                                                      On This Page

                                                                                                                                      Constructors
                                                                                                                                      Properties
                                                                                                                                      diff --git a/docs/classes/server.TransactionStore.html b/docs/classes/server.TransactionStore.html index 730ca93d5..37ea5c501 100644 --- a/docs/classes/server.TransactionStore.html +++ b/docs/classes/server.TransactionStore.html @@ -1,15 +1,15 @@ -TransactionStore | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                        Preparing search index...

                                                                                                                                        Class TransactionStore

                                                                                                                                        TransactionStore is responsible for storing the state required to successfully complete +TransactionStore | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                          Preparing search index...

                                                                                                                                          Class TransactionStore

                                                                                                                                          TransactionStore is responsible for storing the state required to successfully complete an authentication transaction. The store relies on encrypted, stateless cookies to store the transaction state.

                                                                                                                                          -
                                                                                                                                          Index

                                                                                                                                          Constructors

                                                                                                                                          constructor +
                                                                                                                                          Index

                                                                                                                                          Constructors

                                                                                                                                          constructor

                                                                                                                                          Methods

                                                                                                                                          delete deleteAll get getCookiePrefix save -

                                                                                                                                          Constructors

                                                                                                                                          Methods

                                                                                                                                          • Parameters

                                                                                                                                            • resCookies: ResponseCookies
                                                                                                                                            • state: string

                                                                                                                                            Returns Promise<void>

                                                                                                                                          • Deletes all transaction cookies based on the configured prefix.

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • reqCookies: RequestCookies
                                                                                                                                            • resCookies: ResponseCookies

                                                                                                                                            Returns Promise<void>

                                                                                                                                          • Saves the transaction state to an encrypted cookie.

                                                                                                                                            +

                                                                                                                                          Constructors

                                                                                                                                          Methods

                                                                                                                                          • Parameters

                                                                                                                                            • resCookies: ResponseCookies
                                                                                                                                            • state: string

                                                                                                                                            Returns Promise<void>

                                                                                                                                          • Deletes all transaction cookies based on the configured prefix.

                                                                                                                                            +

                                                                                                                                            Parameters

                                                                                                                                            • reqCookies: RequestCookies
                                                                                                                                            • resCookies: ResponseCookies

                                                                                                                                            Returns Promise<void>

                                                                                                                                          • Saves the transaction state to an encrypted cookie.

                                                                                                                                            Parameters

                                                                                                                                            • resCookies: ResponseCookies

                                                                                                                                              The response cookies object to set the transaction cookie on

                                                                                                                                            • transactionState: TransactionState

                                                                                                                                              The transaction state to save

                                                                                                                                            • OptionalreqCookies: RequestCookies

                                                                                                                                              Optional request cookies to check for existing transactions. @@ -17,4 +17,4 @@ will check for existing transaction cookies. When omitted, the existence check is skipped for performance optimization.

                                                                                                                                            Returns Promise<void>

                                                                                                                                            When transaction state is missing required state parameter

                                                                                                                                            -

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          On This Page

                                                                                                                                          Constructors
                                                                                                                                          Methods
                                                                                                                                          +

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          On This Page

                                                                                                                                          Constructors
                                                                                                                                          Methods
                                                                                                                                          diff --git a/docs/enums/errors.AccessTokenErrorCode.html b/docs/enums/errors.AccessTokenErrorCode.html index 6e074f8c1..65d7709f4 100644 --- a/docs/enums/errors.AccessTokenErrorCode.html +++ b/docs/enums/errors.AccessTokenErrorCode.html @@ -1,4 +1,4 @@ -AccessTokenErrorCode | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                            Preparing search index...

                                                                                                                                            Enumeration AccessTokenErrorCode

                                                                                                                                            Index

                                                                                                                                            Enumeration Members

                                                                                                                                            FAILED_TO_REFRESH_TOKEN +AccessTokenErrorCode | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                              Preparing search index...

                                                                                                                                              Enumeration AccessTokenErrorCode

                                                                                                                                              Index

                                                                                                                                              Enumeration Members

                                                                                                                                              FAILED_TO_REFRESH_TOKEN MISSING_REFRESH_TOKEN MISSING_SESSION -

                                                                                                                                              Enumeration Members

                                                                                                                                              FAILED_TO_REFRESH_TOKEN: "failed_to_refresh_token"
                                                                                                                                              MISSING_REFRESH_TOKEN: "missing_refresh_token"
                                                                                                                                              MISSING_SESSION: "missing_session"

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Enumeration Members
                                                                                                                                              +

                                                                                                                                              Enumeration Members

                                                                                                                                              FAILED_TO_REFRESH_TOKEN: "failed_to_refresh_token"
                                                                                                                                              MISSING_REFRESH_TOKEN: "missing_refresh_token"
                                                                                                                                              MISSING_SESSION: "missing_session"

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Enumeration Members
                                                                                                                                              diff --git a/docs/enums/errors.AccessTokenForConnectionErrorCode.html b/docs/enums/errors.AccessTokenForConnectionErrorCode.html index d9e0e7ca8..ed7f96fc5 100644 --- a/docs/enums/errors.AccessTokenForConnectionErrorCode.html +++ b/docs/enums/errors.AccessTokenForConnectionErrorCode.html @@ -1,8 +1,8 @@ -AccessTokenForConnectionErrorCode | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                Preparing search index...

                                                                                                                                                Enumeration AccessTokenForConnectionErrorCode

                                                                                                                                                Enum representing error codes related to access tokens for connections.

                                                                                                                                                -
                                                                                                                                                Index

                                                                                                                                                Enumeration Members

                                                                                                                                                FAILED_TO_EXCHANGE +AccessTokenForConnectionErrorCode | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Enumeration AccessTokenForConnectionErrorCode

                                                                                                                                                  Enum representing error codes related to access tokens for connections.

                                                                                                                                                  +
                                                                                                                                                  Index

                                                                                                                                                  Enumeration Members

                                                                                                                                                  FAILED_TO_EXCHANGE MISSING_REFRESH_TOKEN MISSING_SESSION

                                                                                                                                                  Enumeration Members

                                                                                                                                                  FAILED_TO_EXCHANGE: "failed_to_exchange_refresh_token"

                                                                                                                                                  Failed to exchange the refresh token.

                                                                                                                                                  -
                                                                                                                                                  MISSING_REFRESH_TOKEN: "missing_refresh_token"

                                                                                                                                                  The refresh token is missing.

                                                                                                                                                  -
                                                                                                                                                  MISSING_SESSION: "missing_session"

                                                                                                                                                  The session is missing.

                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Enumeration Members
                                                                                                                                                  +
                                                                                                                                                  MISSING_REFRESH_TOKEN: "missing_refresh_token"

                                                                                                                                                  The refresh token is missing.

                                                                                                                                                  +
                                                                                                                                                  MISSING_SESSION: "missing_session"

                                                                                                                                                  The session is missing.

                                                                                                                                                  +

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Enumeration Members
                                                                                                                                                  diff --git a/docs/enums/errors.ConnectAccountErrorCodes.html b/docs/enums/errors.ConnectAccountErrorCodes.html index 806df0112..ca7b9bc63 100644 --- a/docs/enums/errors.ConnectAccountErrorCodes.html +++ b/docs/enums/errors.ConnectAccountErrorCodes.html @@ -1,8 +1,8 @@ -ConnectAccountErrorCodes | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Enumeration ConnectAccountErrorCodes

                                                                                                                                                    Enum representing error codes related to the connect account flow.

                                                                                                                                                    -
                                                                                                                                                    Index

                                                                                                                                                    Enumeration Members

                                                                                                                                                    FAILED_TO_COMPLETE +ConnectAccountErrorCodes | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Enumeration ConnectAccountErrorCodes

                                                                                                                                                      Enum representing error codes related to the connect account flow.

                                                                                                                                                      +
                                                                                                                                                      Index

                                                                                                                                                      Enumeration Members

                                                                                                                                                      FAILED_TO_COMPLETE FAILED_TO_INITIATE MISSING_SESSION

                                                                                                                                                      Enumeration Members

                                                                                                                                                      FAILED_TO_COMPLETE: "failed_to_complete"

                                                                                                                                                      Failed to complete the connect account flow.

                                                                                                                                                      -
                                                                                                                                                      FAILED_TO_INITIATE: "failed_to_initiate"

                                                                                                                                                      Failed to initiate the connect account flow.

                                                                                                                                                      -
                                                                                                                                                      MISSING_SESSION: "missing_session"

                                                                                                                                                      The session is missing.

                                                                                                                                                      -

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Enumeration Members
                                                                                                                                                      +
                                                                                                                                                      FAILED_TO_INITIATE: "failed_to_initiate"

                                                                                                                                                      Failed to initiate the connect account flow.

                                                                                                                                                      +
                                                                                                                                                      MISSING_SESSION: "missing_session"

                                                                                                                                                      The session is missing.

                                                                                                                                                      +

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Enumeration Members
                                                                                                                                                      diff --git a/docs/enums/errors.CustomTokenExchangeErrorCode.html b/docs/enums/errors.CustomTokenExchangeErrorCode.html index ec61f50e9..5676a5342 100644 --- a/docs/enums/errors.CustomTokenExchangeErrorCode.html +++ b/docs/enums/errors.CustomTokenExchangeErrorCode.html @@ -1,10 +1,10 @@ -CustomTokenExchangeErrorCode | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Enumeration CustomTokenExchangeErrorCode

                                                                                                                                                        Error codes for Custom Token Exchange errors.

                                                                                                                                                        -
                                                                                                                                                        Index

                                                                                                                                                        Enumeration Members

                                                                                                                                                        EXCHANGE_FAILED +CustomTokenExchangeErrorCode | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Enumeration CustomTokenExchangeErrorCode

                                                                                                                                                          Error codes for Custom Token Exchange errors.

                                                                                                                                                          +
                                                                                                                                                          Index

                                                                                                                                                          Enumeration Members

                                                                                                                                                          EXCHANGE_FAILED INVALID_SUBJECT_TOKEN_TYPE MISSING_ACTOR_TOKEN_TYPE MISSING_SUBJECT_TOKEN

                                                                                                                                                          Enumeration Members

                                                                                                                                                          EXCHANGE_FAILED: "exchange_failed"

                                                                                                                                                          The token exchange request failed.

                                                                                                                                                          -
                                                                                                                                                          INVALID_SUBJECT_TOKEN_TYPE: "invalid_subject_token_type"

                                                                                                                                                          The subject_token_type is not a valid URI, wrong length, or uses a reserved namespace.

                                                                                                                                                          -
                                                                                                                                                          MISSING_ACTOR_TOKEN_TYPE: "missing_actor_token_type"

                                                                                                                                                          The actor_token was provided without actor_token_type.

                                                                                                                                                          -
                                                                                                                                                          MISSING_SUBJECT_TOKEN: "missing_subject_token"

                                                                                                                                                          The subject_token is missing or empty.

                                                                                                                                                          -

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Enumeration Members
                                                                                                                                                          +
                                                                                                                                                          INVALID_SUBJECT_TOKEN_TYPE: "invalid_subject_token_type"

                                                                                                                                                          The subject_token_type is not a valid URI, wrong length, or uses a reserved namespace.

                                                                                                                                                          +
                                                                                                                                                          MISSING_ACTOR_TOKEN_TYPE: "missing_actor_token_type"

                                                                                                                                                          The actor_token was provided without actor_token_type.

                                                                                                                                                          +
                                                                                                                                                          MISSING_SUBJECT_TOKEN: "missing_subject_token"

                                                                                                                                                          The subject_token is missing or empty.

                                                                                                                                                          +

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Enumeration Members
                                                                                                                                                          diff --git a/docs/enums/errors.DPoPErrorCode.html b/docs/enums/errors.DPoPErrorCode.html index d939ae138..5ad294471 100644 --- a/docs/enums/errors.DPoPErrorCode.html +++ b/docs/enums/errors.DPoPErrorCode.html @@ -1,16 +1,16 @@ -DPoPErrorCode | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Enumeration DPoPErrorCode

                                                                                                                                                            Error codes for DPoP-related errors.

                                                                                                                                                            +DPoPErrorCode | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Enumeration DPoPErrorCode

                                                                                                                                                              Error codes for DPoP-related errors.

                                                                                                                                                              These error codes categorize different types of failures that can occur during DPoP (Demonstrating Proof-of-Possession) operations.

                                                                                                                                                              -
                                                                                                                                                              Index

                                                                                                                                                              Enumeration Members

                                                                                                                                                              DPOP_CONFIGURATION_ERROR +
                                                                                                                                                              Index

                                                                                                                                                              Enumeration Members

                                                                                                                                                              DPOP_CONFIGURATION_ERROR DPOP_JKT_CALCULATION_FAILED DPOP_KEY_EXPORT_FAILED

                                                                                                                                                              Enumeration Members

                                                                                                                                                              DPOP_CONFIGURATION_ERROR: "dpop_configuration_error"

                                                                                                                                                              DPoP configuration is invalid or incomplete. This occurs when the provided DPoP configuration contains invalid values or missing required components.

                                                                                                                                                              -
                                                                                                                                                              DPOP_JKT_CALCULATION_FAILED: "dpop_jkt_calculation_failed"

                                                                                                                                                              Failed to calculate dpop_jkt (JWK thumbprint) parameter. +

                                                                                                                                                              DPOP_JKT_CALCULATION_FAILED: "dpop_jkt_calculation_failed"

                                                                                                                                                              Failed to calculate dpop_jkt (JWK thumbprint) parameter. This occurs when the SDK cannot generate the required thumbprint from the provided public key for the authorization request.

                                                                                                                                                              -
                                                                                                                                                              DPOP_KEY_EXPORT_FAILED: "dpop_key_export_failed"

                                                                                                                                                              Failed to export DPoP public key to JWK format. +

                                                                                                                                                              DPOP_KEY_EXPORT_FAILED: "dpop_key_export_failed"

                                                                                                                                                              Failed to export DPoP public key to JWK format. This occurs when the SDK cannot convert the CryptoKey to the JSON Web Key format required for DPoP proofs.

                                                                                                                                                              -

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility

                                                                                                                                                              On This Page

                                                                                                                                                              Enumeration Members
                                                                                                                                                              +

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility

                                                                                                                                                              On This Page

                                                                                                                                                              Enumeration Members
                                                                                                                                                              diff --git a/docs/enums/types.RESPONSE_TYPES.html b/docs/enums/types.RESPONSE_TYPES.html index 88a8ffb07..fe972008b 100644 --- a/docs/enums/types.RESPONSE_TYPES.html +++ b/docs/enums/types.RESPONSE_TYPES.html @@ -1,5 +1,5 @@ -RESPONSE_TYPES | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Enumeration RESPONSE_TYPES

                                                                                                                                                                Index

                                                                                                                                                                Enumeration Members

                                                                                                                                                                CODE +RESPONSE_TYPES | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Enumeration RESPONSE_TYPES

                                                                                                                                                                  Index

                                                                                                                                                                  Enumeration Members

                                                                                                                                                                  CODE CONNECT_CODE

                                                                                                                                                                  Enumeration Members

                                                                                                                                                                  CODE: "code"

                                                                                                                                                                  Authorization Code flow.

                                                                                                                                                                  -
                                                                                                                                                                  CONNECT_CODE: "connect_code"

                                                                                                                                                                  Connect Account flow.

                                                                                                                                                                  -

                                                                                                                                                                  Settings

                                                                                                                                                                  Member Visibility

                                                                                                                                                                  On This Page

                                                                                                                                                                  Enumeration Members
                                                                                                                                                                  +
                                                                                                                                                                  CONNECT_CODE: "connect_code"

                                                                                                                                                                  Connect Account flow.

                                                                                                                                                                  +

                                                                                                                                                                  Settings

                                                                                                                                                                  Member Visibility

                                                                                                                                                                  On This Page

                                                                                                                                                                  Enumeration Members
                                                                                                                                                                  diff --git a/docs/enums/types.SUBJECT_TOKEN_TYPES.html b/docs/enums/types.SUBJECT_TOKEN_TYPES.html index 78a68555b..26979e850 100644 --- a/docs/enums/types.SUBJECT_TOKEN_TYPES.html +++ b/docs/enums/types.SUBJECT_TOKEN_TYPES.html @@ -1,7 +1,7 @@ -SUBJECT_TOKEN_TYPES | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Enumeration SUBJECT_TOKEN_TYPES

                                                                                                                                                                    Index

                                                                                                                                                                    Enumeration Members

                                                                                                                                                                    SUBJECT_TYPE_ACCESS_TOKEN +SUBJECT_TOKEN_TYPES | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Enumeration SUBJECT_TOKEN_TYPES

                                                                                                                                                                      Index

                                                                                                                                                                      Enumeration Members

                                                                                                                                                                      SUBJECT_TYPE_ACCESS_TOKEN SUBJECT_TYPE_REFRESH_TOKEN

                                                                                                                                                                      Enumeration Members

                                                                                                                                                                      SUBJECT_TYPE_ACCESS_TOKEN: "urn:ietf:params:oauth:token-type:access_token"

                                                                                                                                                                      Indicates that the token is an OAuth 2.0 access token issued by the given authorization server.

                                                                                                                                                                      RFC 8693 Section 3-3.2

                                                                                                                                                                      -
                                                                                                                                                                      SUBJECT_TYPE_REFRESH_TOKEN: "urn:ietf:params:oauth:token-type:refresh_token"

                                                                                                                                                                      Indicates that the token is an OAuth 2.0 refresh token issued by the given authorization server.

                                                                                                                                                                      +
                                                                                                                                                                      SUBJECT_TYPE_REFRESH_TOKEN: "urn:ietf:params:oauth:token-type:refresh_token"

                                                                                                                                                                      Indicates that the token is an OAuth 2.0 refresh token issued by the given authorization server.

                                                                                                                                                                      RFC 8693 Section 3-3.4

                                                                                                                                                                      -

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      On This Page

                                                                                                                                                                      Enumeration Members
                                                                                                                                                                      +

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      On This Page

                                                                                                                                                                      Enumeration Members
                                                                                                                                                                      diff --git a/docs/functions/client.Auth0Provider.html b/docs/functions/client.Auth0Provider.html index 18116c5e5..37eb07d22 100644 --- a/docs/functions/client.Auth0Provider.html +++ b/docs/functions/client.Auth0Provider.html @@ -1 +1 @@ -Auth0Provider | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Function Auth0Provider

                                                                                                                                                                        Settings

                                                                                                                                                                        Member Visibility
                                                                                                                                                                        +Auth0Provider | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Function Auth0Provider

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility
                                                                                                                                                                          diff --git a/docs/functions/client.getAccessToken.html b/docs/functions/client.getAccessToken.html index 14c5598e5..f4477a9a3 100644 --- a/docs/functions/client.getAccessToken.html +++ b/docs/functions/client.getAccessToken.html @@ -1,11 +1,11 @@ -getAccessToken | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Function getAccessToken

                                                                                                                                                                            • Fetches an access token for the currently logged-in user.

                                                                                                                                                                              +getAccessToken | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Function getAccessToken

                                                                                                                                                                              • Fetches an access token for the currently logged-in user.

                                                                                                                                                                                Parameters

                                                                                                                                                                                • Optionaloptions: AccessTokenOptions & { includeFullResponse?: false }

                                                                                                                                                                                  Options for fetching the access token, including optional audience and scope.

                                                                                                                                                                                Returns Promise<string>

                                                                                                                                                                                The access token as a string, or the full token response when includeFullResponse is true.

                                                                                                                                                                                Passing audience or scope relies on MRRT to be configured in your Auth0 Application.

                                                                                                                                                                                https://auth0.com/docs/secure/tokens/refresh-tokens/multi-resource-refresh-token/configure-and-implement-multi-resource-refresh-token

                                                                                                                                                                                -

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility
                                                                                                                                                                              +

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility
                                                                                                                                                                              diff --git a/docs/functions/client.useUser.html b/docs/functions/client.useUser.html index e11871998..f7a05eaeb 100644 --- a/docs/functions/client.useUser.html +++ b/docs/functions/client.useUser.html @@ -1 +1 @@ -useUser | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Function useUser

                                                                                                                                                                                • Returns
                                                                                                                                                                                      | {
                                                                                                                                                                                          error: Error;
                                                                                                                                                                                          invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                          isLoading: boolean;
                                                                                                                                                                                          user: null;
                                                                                                                                                                                      }
                                                                                                                                                                                      | {
                                                                                                                                                                                          error: null;
                                                                                                                                                                                          invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                          isLoading: boolean;
                                                                                                                                                                                          user: User;
                                                                                                                                                                                      }
                                                                                                                                                                                      | {
                                                                                                                                                                                          error: undefined;
                                                                                                                                                                                          invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                          isLoading: boolean;
                                                                                                                                                                                          user: undefined;
                                                                                                                                                                                      }

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility
                                                                                                                                                                                +useUser | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Function useUser

                                                                                                                                                                                  • Returns
                                                                                                                                                                                        | {
                                                                                                                                                                                            error: Error;
                                                                                                                                                                                            invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                            isLoading: boolean;
                                                                                                                                                                                            user: null;
                                                                                                                                                                                        }
                                                                                                                                                                                        | {
                                                                                                                                                                                            error: null;
                                                                                                                                                                                            invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                            isLoading: boolean;
                                                                                                                                                                                            user: User;
                                                                                                                                                                                        }
                                                                                                                                                                                        | {
                                                                                                                                                                                            error: undefined;
                                                                                                                                                                                            invalidate: () => Promise<User | undefined>;
                                                                                                                                                                                            isLoading: boolean;
                                                                                                                                                                                            user: undefined;
                                                                                                                                                                                        }

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                  diff --git a/docs/functions/server.filterDefaultIdTokenClaims.html b/docs/functions/server.filterDefaultIdTokenClaims.html index b9b8b4ce4..fefec7516 100644 --- a/docs/functions/server.filterDefaultIdTokenClaims.html +++ b/docs/functions/server.filterDefaultIdTokenClaims.html @@ -1,4 +1,4 @@ -filterDefaultIdTokenClaims | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Function filterDefaultIdTokenClaims

                                                                                                                                                                                    • Filters the claims to only include those that are considered default.

                                                                                                                                                                                      +filterDefaultIdTokenClaims | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Function filterDefaultIdTokenClaims

                                                                                                                                                                                        • Filters the claims to only include those that are considered default.

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          • claims: { [key: string]: any }

                                                                                                                                                                                            The claims to filter.

                                                                                                                                                                                          Returns User

                                                                                                                                                                                          The filtered claims containing only default ID token claims.

                                                                                                                                                                                          -

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                        +

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                      diff --git a/docs/functions/server.generateDpopKeyPair.html b/docs/functions/server.generateDpopKeyPair.html index aa57355b8..fa204bfeb 100644 --- a/docs/functions/server.generateDpopKeyPair.html +++ b/docs/functions/server.generateDpopKeyPair.html @@ -1,4 +1,4 @@ -generateDpopKeyPair | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Function generateDpopKeyPair

                                                                                                                                                                                        • Generates a new ES256 key pair for DPoP (Demonstrating Proof-of-Possession) operations.

                                                                                                                                                                                          +generateDpopKeyPair | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Function generateDpopKeyPair

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                          +

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                          diff --git a/docs/functions/testing.generateSessionCookie.html b/docs/functions/testing.generateSessionCookie.html index 907864a4d..77e591526 100644 --- a/docs/functions/testing.generateSessionCookie.html +++ b/docs/functions/testing.generateSessionCookie.html @@ -1 +1 @@ -generateSessionCookie | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Function generateSessionCookie

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                            +generateSessionCookie | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Function generateSessionCookie

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                              diff --git a/docs/hierarchy.html b/docs/hierarchy.html index e5f157b3f..0fc887b5a 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -@auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.17.1

                                                                                                                                                                                                Hierarchy Summary

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                +@auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                  Hierarchy Summary

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                  diff --git a/docs/index.html b/docs/index.html index 6bcc85642..be037f3ad 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -@auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.17.1

                                                                                                                                                                                                    Auth0 Next.js SDK Banner

                                                                                                                                                                                                    +@auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                      Auth0 Next.js SDK Banner

                                                                                                                                                                                                      The Auth0 Next.js SDK is a library for implementing user authentication in Next.js applications.

                                                                                                                                                                                                      Auth0 Next.js SDK Release Ask DeepWiki @@ -405,4 +405,4 @@

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      DocumentationGetting StartedCustomizing the clientSession Cookie ConfigurationBase PathConfiguration ValidationMultiple Custom Domains (MCD)RoutesFeedbackVulnerability ReportingWhat is Auth0?
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      DocumentationGetting StartedCustomizing the clientSession Cookie ConfigurationBase PathConfiguration ValidationMultiple Custom Domains (MCD)RoutesFeedbackVulnerability ReportingWhat is Auth0?
                                                                                                                                                                                                      diff --git a/docs/interfaces/client.WithPageAuthRequiredOptions.html b/docs/interfaces/client.WithPageAuthRequiredOptions.html index 6c323f41e..e2d0d1d85 100644 --- a/docs/interfaces/client.WithPageAuthRequiredOptions.html +++ b/docs/interfaces/client.WithPageAuthRequiredOptions.html @@ -1,17 +1,17 @@ -WithPageAuthRequiredOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Interface WithPageAuthRequiredOptions

                                                                                                                                                                                                        Options to customize the withPageAuthRequired higher order component.

                                                                                                                                                                                                        -
                                                                                                                                                                                                        interface WithPageAuthRequiredOptions {
                                                                                                                                                                                                            onError?: (error: Error) => Element;
                                                                                                                                                                                                            onRedirecting?: () => Element;
                                                                                                                                                                                                            returnTo?: string;
                                                                                                                                                                                                        }
                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        onError? +WithPageAuthRequiredOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Interface WithPageAuthRequiredOptions

                                                                                                                                                                                                          Options to customize the withPageAuthRequired higher order component.

                                                                                                                                                                                                          +
                                                                                                                                                                                                          interface WithPageAuthRequiredOptions {
                                                                                                                                                                                                              onError?: (error: Error) => Element;
                                                                                                                                                                                                              onRedirecting?: () => Element;
                                                                                                                                                                                                              returnTo?: string;
                                                                                                                                                                                                          }
                                                                                                                                                                                                          Index

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          onError? onRedirecting? returnTo?

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          onError?: (error: Error) => Element
                                                                                                                                                                                                          withPageAuthRequired(Profile, {
                                                                                                                                                                                                            onError: error => <div>Error: {error.message}</div>
                                                                                                                                                                                                          });

                                                                                                                                                                                                          Render a fallback in case of error fetching the user from the profile API route.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          onRedirecting?: () => Element
                                                                                                                                                                                                          withPageAuthRequired(Profile, {
                                                                                                                                                                                                            onRedirecting: () => <div>Redirecting...</div>
                                                                                                                                                                                                          });
+
                                                                                                                                                                                                          onRedirecting?: () => Element
                                                                                                                                                                                                          withPageAuthRequired(Profile, {
                                                                                                                                                                                                            onRedirecting: () => <div>Redirecting...</div>
                                                                                                                                                                                                          });

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

                                                                                                                                                                                                          -
                                                                                                                                                                                                          returnTo?: string
                                                                                                                                                                                                          withPageAuthRequired(Profile, {
                                                                                                                                                                                                            returnTo: '/profile'
                                                                                                                                                                                                          });
+
                                                                                                                                                                                                          returnTo?: string
                                                                                                                                                                                                          withPageAuthRequired(Profile, {
                                                                                                                                                                                                            returnTo: '/profile'
                                                                                                                                                                                                          });

                                                                                                                                                                                                          Add a path 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/interfaces/errors.MfaApiErrorResponse.html b/docs/interfaces/errors.MfaApiErrorResponse.html index 550617469..e7fe6a63a 100644 --- a/docs/interfaces/errors.MfaApiErrorResponse.html +++ b/docs/interfaces/errors.MfaApiErrorResponse.html @@ -1,6 +1,6 @@ -MfaApiErrorResponse | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface MfaApiErrorResponse

                                                                                                                                                                                                            Interface for Auth0 MFA API error responses. +MfaApiErrorResponse | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Interface MfaApiErrorResponse

                                                                                                                                                                                                              Interface for Auth0 MFA API error responses. All MFA errors from Auth0 follow this shape (snake_case).

                                                                                                                                                                                                              -
                                                                                                                                                                                                              interface MfaApiErrorResponse {
                                                                                                                                                                                                                  error: string;
                                                                                                                                                                                                                  error_description: string;
                                                                                                                                                                                                                  message?: string;
                                                                                                                                                                                                              }
                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              error +
                                                                                                                                                                                                              interface MfaApiErrorResponse {
                                                                                                                                                                                                                  error: string;
                                                                                                                                                                                                                  error_description: string;
                                                                                                                                                                                                                  message?: string;
                                                                                                                                                                                                              }
                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              error error_description message? -

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              error: string
                                                                                                                                                                                                              error_description: string
                                                                                                                                                                                                              message?: string

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              Properties
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              error: string
                                                                                                                                                                                                              error_description: string
                                                                                                                                                                                                              message?: string

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              Properties
                                                                                                                                                                                                              diff --git a/docs/interfaces/server.MfaRequirements.html b/docs/interfaces/server.MfaRequirements.html index 668890caa..6ea273a16 100644 --- a/docs/interfaces/server.MfaRequirements.html +++ b/docs/interfaces/server.MfaRequirements.html @@ -1,8 +1,8 @@ -MfaRequirements | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Interface MfaRequirements

                                                                                                                                                                                                                MFA requirements from an mfa_required error response. +MfaRequirements | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Interface MfaRequirements

                                                                                                                                                                                                                  MFA requirements from an mfa_required error response. Indicates which MFA methods are available for the user. Matches Auth0 API response shape and auth0-spa-js type.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  interface MfaRequirements {
                                                                                                                                                                                                                      challenge?: { type: string }[];
                                                                                                                                                                                                                      enroll?: { type: string }[];
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  challenge? +
                                                                                                                                                                                                                  interface MfaRequirements {
                                                                                                                                                                                                                      challenge?: { type: string }[];
                                                                                                                                                                                                                      enroll?: { type: string }[];
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  challenge? enroll?

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  challenge?: { type: string }[]

                                                                                                                                                                                                                  Available challenge types (existing authenticators)

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  enroll?: { type: string }[]

                                                                                                                                                                                                                  Required enrollment types (user needs to enroll new authenticator)

                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  enroll?: { type: string }[]

                                                                                                                                                                                                                  Required enrollment types (user needs to enroll new authenticator)

                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                  diff --git a/docs/interfaces/types.AccessTokenForConnectionOptions.html b/docs/interfaces/types.AccessTokenForConnectionOptions.html index 1e7af1627..2aa5d676d 100644 --- a/docs/interfaces/types.AccessTokenForConnectionOptions.html +++ b/docs/interfaces/types.AccessTokenForConnectionOptions.html @@ -1,14 +1,14 @@ -AccessTokenForConnectionOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Interface AccessTokenForConnectionOptions

                                                                                                                                                                                                                    Options for retrieving a connection access token.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    interface AccessTokenForConnectionOptions {
                                                                                                                                                                                                                        connection: string;
                                                                                                                                                                                                                        login_hint?: string;
                                                                                                                                                                                                                        subject_token_type?: SUBJECT_TOKEN_TYPES;
                                                                                                                                                                                                                    }
                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    connection +AccessTokenForConnectionOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Interface AccessTokenForConnectionOptions

                                                                                                                                                                                                                      Options for retrieving a connection access token.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      interface AccessTokenForConnectionOptions {
                                                                                                                                                                                                                          connection: string;
                                                                                                                                                                                                                          login_hint?: string;
                                                                                                                                                                                                                          subject_token_type?: SUBJECT_TOKEN_TYPES;
                                                                                                                                                                                                                      }
                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      connection login_hint? subject_token_type?

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      connection: string

                                                                                                                                                                                                                      The connection name for while you want to retrieve the access token.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      login_hint?: string

                                                                                                                                                                                                                      An optional login hint to pass to the authorization server.

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      subject_token_type?: SUBJECT_TOKEN_TYPES

                                                                                                                                                                                                                      The type of token that is being exchanged.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      login_hint?: string

                                                                                                                                                                                                                      An optional login hint to pass to the authorization server.

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      subject_token_type?: SUBJECT_TOKEN_TYPES

                                                                                                                                                                                                                      The type of token that is being exchanged.

                                                                                                                                                                                                                      Uses the SUBJECT_TOKEN_TYPES enum with the following allowed values:

                                                                                                                                                                                                                      • SUBJECT_TYPE_REFRESH_TOKEN: "urn:ietf:params:oauth:token-type:refresh_token"
                                                                                                                                                                                                                      • SUBJECT_TYPE_ACCESS_TOKEN: "urn:ietf:params:oauth:token-type:access_token"

                                                                                                                                                                                                                      Defaults to SUBJECT_TYPE_REFRESH_TOKEN.

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                      diff --git a/docs/interfaces/types.AccessTokenSet.html b/docs/interfaces/types.AccessTokenSet.html index 43553486e..67530223b 100644 --- a/docs/interfaces/types.AccessTokenSet.html +++ b/docs/interfaces/types.AccessTokenSet.html @@ -1,7 +1,7 @@ -AccessTokenSet | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Interface AccessTokenSet

                                                                                                                                                                                                                        interface AccessTokenSet {
                                                                                                                                                                                                                            accessToken: string;
                                                                                                                                                                                                                            audience: string;
                                                                                                                                                                                                                            expiresAt: number;
                                                                                                                                                                                                                            requestedScope?: string;
                                                                                                                                                                                                                            scope?: string;
                                                                                                                                                                                                                            token_type?: string;
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        accessToken +AccessTokenSet | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Interface AccessTokenSet

                                                                                                                                                                                                                          interface AccessTokenSet {
                                                                                                                                                                                                                              accessToken: string;
                                                                                                                                                                                                                              audience: string;
                                                                                                                                                                                                                              expiresAt: number;
                                                                                                                                                                                                                              requestedScope?: string;
                                                                                                                                                                                                                              scope?: string;
                                                                                                                                                                                                                              token_type?: string;
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          accessToken audience expiresAt requestedScope? scope? token_type? -

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          accessToken: string
                                                                                                                                                                                                                          audience: string
                                                                                                                                                                                                                          expiresAt: number
                                                                                                                                                                                                                          requestedScope?: string
                                                                                                                                                                                                                          scope?: string
                                                                                                                                                                                                                          token_type?: string

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          accessToken: string
                                                                                                                                                                                                                          audience: string
                                                                                                                                                                                                                          expiresAt: number
                                                                                                                                                                                                                          requestedScope?: string
                                                                                                                                                                                                                          scope?: string
                                                                                                                                                                                                                          token_type?: string

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                          diff --git a/docs/interfaces/types.Auth0ClientOptions.html b/docs/interfaces/types.Auth0ClientOptions.html index 110be15dc..d5b9ee586 100644 --- a/docs/interfaces/types.Auth0ClientOptions.html +++ b/docs/interfaces/types.Auth0ClientOptions.html @@ -1,4 +1,4 @@ -Auth0ClientOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Interface Auth0ClientOptions

                                                                                                                                                                                                                            interface Auth0ClientOptions {
                                                                                                                                                                                                                                allowInsecureRequests?: boolean;
                                                                                                                                                                                                                                appBaseUrl?: string | string[];
                                                                                                                                                                                                                                authorizationParameters?: AuthorizationParameters;
                                                                                                                                                                                                                                beforeSessionSaved?: BeforeSessionSavedHook;
                                                                                                                                                                                                                                clientAssertionSigningAlg?: string;
                                                                                                                                                                                                                                clientAssertionSigningKey?: string | CryptoKey;
                                                                                                                                                                                                                                clientId?: string;
                                                                                                                                                                                                                                clientSecret?: string;
                                                                                                                                                                                                                                discoveryCache?: DiscoveryCacheOptions;
                                                                                                                                                                                                                                domain?: string | DomainResolver;
                                                                                                                                                                                                                                dpopKeyPair?: DpopKeyPair;
                                                                                                                                                                                                                                dpopOptions?: DpopOptions;
                                                                                                                                                                                                                                enableAccessTokenEndpoint?: boolean;
                                                                                                                                                                                                                                enableConnectAccountEndpoint?: boolean;
                                                                                                                                                                                                                                enableParallelTransactions?: boolean;
                                                                                                                                                                                                                                enableTelemetry?: boolean;
                                                                                                                                                                                                                                httpTimeout?: number;
                                                                                                                                                                                                                                includeIdTokenHintInOIDCLogoutUrl?: boolean;
                                                                                                                                                                                                                                logoutStrategy?: LogoutStrategy;
                                                                                                                                                                                                                                mfaTokenTtl?: number;
                                                                                                                                                                                                                                noContentProfileResponseWhenUnauthenticated?: boolean;
                                                                                                                                                                                                                                onCallback?: OnCallbackHook;
                                                                                                                                                                                                                                pushedAuthorizationRequests?: boolean;
                                                                                                                                                                                                                                routes?: Partial<
                                                                                                                                                                                                                                    Pick<
                                                                                                                                                                                                                                        Routes,
                                                                                                                                                                                                                                        "login"
                                                                                                                                                                                                                                        | "callback"
                                                                                                                                                                                                                                        | "logout"
                                                                                                                                                                                                                                        | "backChannelLogout"
                                                                                                                                                                                                                                        | "connectAccount",
                                                                                                                                                                                                                                    >,
                                                                                                                                                                                                                                >;
                                                                                                                                                                                                                                secret?: string;
                                                                                                                                                                                                                                session?: SessionConfiguration;
                                                                                                                                                                                                                                sessionStore?: SessionDataStore;
                                                                                                                                                                                                                                signInReturnToPath?: string;
                                                                                                                                                                                                                                tokenRefreshBuffer?: number;
                                                                                                                                                                                                                                transactionCookie?: TransactionCookieOptions;
                                                                                                                                                                                                                                useDPoP?: boolean;
                                                                                                                                                                                                                            }
                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            allowInsecureRequests? +Auth0ClientOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Interface Auth0ClientOptions

                                                                                                                                                                                                                              interface Auth0ClientOptions {
                                                                                                                                                                                                                                  allowInsecureRequests?: boolean;
                                                                                                                                                                                                                                  appBaseUrl?: string | string[];
                                                                                                                                                                                                                                  authorizationParameters?: AuthorizationParameters;
                                                                                                                                                                                                                                  beforeSessionSaved?: BeforeSessionSavedHook;
                                                                                                                                                                                                                                  clientAssertionSigningAlg?: string;
                                                                                                                                                                                                                                  clientAssertionSigningKey?: string | CryptoKey;
                                                                                                                                                                                                                                  clientId?: string;
                                                                                                                                                                                                                                  clientSecret?: string;
                                                                                                                                                                                                                                  discoveryCache?: DiscoveryCacheOptions;
                                                                                                                                                                                                                                  domain?: string | DomainResolver;
                                                                                                                                                                                                                                  dpopKeyPair?: DpopKeyPair;
                                                                                                                                                                                                                                  dpopOptions?: DpopOptions;
                                                                                                                                                                                                                                  enableAccessTokenEndpoint?: boolean;
                                                                                                                                                                                                                                  enableConnectAccountEndpoint?: boolean;
                                                                                                                                                                                                                                  enableParallelTransactions?: boolean;
                                                                                                                                                                                                                                  enableTelemetry?: boolean;
                                                                                                                                                                                                                                  httpTimeout?: number;
                                                                                                                                                                                                                                  includeIdTokenHintInOIDCLogoutUrl?: boolean;
                                                                                                                                                                                                                                  logoutStrategy?: LogoutStrategy;
                                                                                                                                                                                                                                  mfaTokenTtl?: number;
                                                                                                                                                                                                                                  noContentProfileResponseWhenUnauthenticated?: boolean;
                                                                                                                                                                                                                                  onCallback?: OnCallbackHook;
                                                                                                                                                                                                                                  pushedAuthorizationRequests?: boolean;
                                                                                                                                                                                                                                  routes?: Partial<
                                                                                                                                                                                                                                      Pick<
                                                                                                                                                                                                                                          Routes,
                                                                                                                                                                                                                                          "login"
                                                                                                                                                                                                                                          | "callback"
                                                                                                                                                                                                                                          | "logout"
                                                                                                                                                                                                                                          | "backChannelLogout"
                                                                                                                                                                                                                                          | "connectAccount",
                                                                                                                                                                                                                                      >,
                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                  secret?: string;
                                                                                                                                                                                                                                  session?: SessionConfiguration;
                                                                                                                                                                                                                                  sessionStore?: SessionDataStore;
                                                                                                                                                                                                                                  signInReturnToPath?: string;
                                                                                                                                                                                                                                  tokenRefreshBuffer?: number;
                                                                                                                                                                                                                                  transactionCookie?: TransactionCookieOptions;
                                                                                                                                                                                                                                  useDPoP?: boolean;
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              allowInsecureRequests? appBaseUrl? authorizationParameters? beforeSessionSaved? @@ -32,7 +32,7 @@

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              allowInsecureRequests?: boolean

                                                                                                                                                                                                                              Allow insecure requests to be made to the authorization server. This can be useful when testing with a mock OIDC provider that does not support TLS, locally. This option can only be used when NODE_ENV is not set to production.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              appBaseUrl?: string | string[]

                                                                                                                                                                                                                              The URL of your application (e.g.: http://localhost:3000).

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              appBaseUrl?: string | string[]

                                                                                                                                                                                                                              The URL of your application (e.g.: http://localhost:3000).

                                                                                                                                                                                                                              Can be a single URL string, or an array of allowed base URLs. When an array is provided, the SDK validates the incoming request origin against the list and uses the matching entry (allow-list mode). This is useful for multi-domain or preview @@ -40,27 +40,27 @@

                                                                                                                                                                                                                              If it's not specified, it will be loaded from the APP_BASE_URL environment variable. Multiple origins can be provided as a comma-separated string (e.g. https://app.example.com,https://myapp.vercel.app). If neither is provided, the SDK will infer it from the request host at runtime.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              authorizationParameters?: AuthorizationParameters

                                                                                                                                                                                                                              Additional parameters to send to the /authorize endpoint.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              beforeSessionSaved?: BeforeSessionSavedHook

                                                                                                                                                                                                                              A method to manipulate the session before persisting it.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              authorizationParameters?: AuthorizationParameters

                                                                                                                                                                                                                              Additional parameters to send to the /authorize endpoint.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              beforeSessionSaved?: BeforeSessionSavedHook

                                                                                                                                                                                                                              A method to manipulate the session before persisting it.

                                                                                                                                                                                                                              See beforeSessionSaved for additional details

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              clientAssertionSigningAlg?: string

                                                                                                                                                                                                                              The algorithm used to sign the client assertion JWT. +

                                                                                                                                                                                                                              clientAssertionSigningAlg?: string

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

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              clientAssertionSigningKey?: string | CryptoKey

                                                                                                                                                                                                                              Private key for use with private_key_jwt clients. +

                                                                                                                                                                                                                              clientAssertionSigningKey?: string | CryptoKey

                                                                                                                                                                                                                              Private key for use with private_key_jwt clients. This should be a string that is the contents of a PEM file or a CryptoKey.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              clientId?: string

                                                                                                                                                                                                                              The Auth0 client ID.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              clientId?: string

                                                                                                                                                                                                                              The Auth0 client ID.

                                                                                                                                                                                                                              If it's not specified, it will be loaded from the AUTH0_CLIENT_ID environment variable.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              clientSecret?: string

                                                                                                                                                                                                                              The Auth0 client secret.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              clientSecret?: string

                                                                                                                                                                                                                              The Auth0 client secret.

                                                                                                                                                                                                                              If it's not specified, it will be loaded from the AUTH0_CLIENT_SECRET environment variable.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              discoveryCache?: DiscoveryCacheOptions

                                                                                                                                                                                                                              Configuration for the OIDC discovery metadata cache. +

                                                                                                                                                                                                                              discoveryCache?: DiscoveryCacheOptions

                                                                                                                                                                                                                              Configuration for the OIDC discovery metadata cache. Controls TTL and maximum cached issuers for MCD resolver mode. Also applies in static mode (single cached entry).

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              domain?: string | DomainResolver

                                                                                                                                                                                                                              The Auth0 domain for the tenant.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              domain?: string | DomainResolver

                                                                                                                                                                                                                              The Auth0 domain for the tenant.

                                                                                                                                                                                                                              • string: Static domain (e.g., "example.us.auth0.com"). Existing behavior preserved.
                                                                                                                                                                                                                              • DomainResolver: Async function resolving domain per-request from headers. @@ -71,7 +71,7 @@
                                                                                                                                                                                                                              • DomainResolver for resolver signature and examples.
                                                                                                                                                                                                                              • MCD Examples
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              dpopKeyPair?: DpopKeyPair

                                                                                                                                                                                                                              ES256 key pair for DPoP proof generation.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              dpopKeyPair?: DpopKeyPair

                                                                                                                                                                                                                              ES256 key pair for DPoP proof generation.

                                                                                                                                                                                                                              If not provided when useDPoP is true, the SDK will attempt to load keys from environment variables AUTH0_DPOP_PUBLIC_KEY and AUTH0_DPOP_PRIVATE_KEY. Keys must be in PEM format and use the P-256 elliptic curve.

                                                                                                                                                                                                                              @@ -85,7 +85,7 @@
                                                                                                                                                                                                                            • DpopKeyPair for the key pair interface
                                                                                                                                                                                                                            • generateDpopKeyPair for generating new key pairs
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                              dpopOptions?: DpopOptions

                                                                                                                                                                                                                              Configuration options for DPoP timing validation and retry behavior.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              dpopOptions?: DpopOptions

                                                                                                                                                                                                                              Configuration options for DPoP timing validation and retry behavior.

                                                                                                                                                                                                                              These options control how the SDK validates DPoP proof timing and handles nonce errors. Proper configuration is important for both security and reliability.

                                                                                                                                                                                                                              const auth0 = new Auth0Client({
                                                                                                                                                                                                                                useDPoP: true,
                                                                                                                                                                                                                                dpopOptions: {
                                                                                                                                                                                                                                  clockTolerance: 60,    // Allow 60 seconds clock difference
                                                                                                                                                                                                                                  clockSkew: 0,          // No clock adjustment needed
                                                                                                                                                                                                                                  retry: {
                                                                                                                                                                                                                                    delay: 200,          // 200ms delay before retry
                                                                                                                                                                                                                                    jitter: true         // Add randomness to prevent thundering herd
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                              });
@@ -95,17 +95,17 @@

                                                                                                                                                                                                                              DpopOptions for detailed option descriptions

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              enableAccessTokenEndpoint?: boolean

                                                                                                                                                                                                                              Boolean value to enable the /auth/access-token endpoint for use in the client app.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              enableAccessTokenEndpoint?: boolean

                                                                                                                                                                                                                              Boolean value to enable the /auth/access-token endpoint for use in the client app.

                                                                                                                                                                                                                              Defaults to true.

                                                                                                                                                                                                                              NOTE: Set this to false if your client does not need to directly interact with resource servers (Token Mediating Backend). This will be false for most apps.

                                                                                                                                                                                                                              A security best practice is to disable this to avoid exposing access tokens to the client app.

                                                                                                                                                                                                                              See: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-browser-based-apps#name-token-mediating-backend

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              enableConnectAccountEndpoint?: boolean

                                                                                                                                                                                                                              If true, the /auth/connect endpoint will be mounted to enable users to connect additional accounts.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              enableParallelTransactions?: boolean
                                                                                                                                                                                                                              enableTelemetry?: boolean

                                                                                                                                                                                                                              Boolean value to opt-out of sending the library name and version to your authorization server +

                                                                                                                                                                                                                              enableConnectAccountEndpoint?: boolean

                                                                                                                                                                                                                              If true, the /auth/connect endpoint will be mounted to enable users to connect additional accounts.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              enableParallelTransactions?: boolean
                                                                                                                                                                                                                              enableTelemetry?: boolean

                                                                                                                                                                                                                              Boolean value to opt-out of sending the library name and version to your authorization server via the Auth0-Client header. Defaults to true.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              httpTimeout?: number

                                                                                                                                                                                                                              Integer value for the HTTP timeout in milliseconds for authentication requests. +

                                                                                                                                                                                                                              httpTimeout?: number

                                                                                                                                                                                                                              Integer value for the HTTP timeout in milliseconds for authentication requests. Defaults to 5000 ms.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              includeIdTokenHintInOIDCLogoutUrl?: boolean

                                                                                                                                                                                                                              Configure whether to include id_token_hint in OIDC logout URLs.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              includeIdTokenHintInOIDCLogoutUrl?: boolean

                                                                                                                                                                                                                              Configure whether to include id_token_hint in OIDC logout URLs.

                                                                                                                                                                                                                              Recommended (default): Set to true to include id_token_hint parameter. Auth0 recommends using id_token_hint for secure logout as per the OIDC specification.

                                                                                                                                                                                                                              @@ -116,40 +116,40 @@ 
                                                                                                                                                                                                                              true (recommended and backwards compatible)
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              logoutStrategy?: LogoutStrategy

                                                                                                                                                                                                                              Configure the logout strategy to use.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              logoutStrategy?: LogoutStrategy

                                                                                                                                                                                                                              Configure the logout strategy to use.

                                                                                                                                                                                                                              • 'auto' (default): Attempts OIDC RP-Initiated Logout first, falls back to /v2/logout if not supported
                                                                                                                                                                                                                              • 'oidc': Always uses OIDC RP-Initiated Logout (requires RP-Initiated Logout to be enabled)
                                                                                                                                                                                                                              • 'v2': Always uses the Auth0 /v2/logout endpoint (supports wildcards in allowed logout URLs)
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              mfaTokenTtl?: number

                                                                                                                                                                                                                              MFA context TTL in seconds. Controls how long encrypted mfa_token remains valid. +

                                                                                                                                                                                                                              mfaTokenTtl?: number

                                                                                                                                                                                                                              MFA context TTL in seconds. Controls how long encrypted mfa_token remains valid. Default: 300 (5 minutes, matching Auth0's mfa_token expiration)

                                                                                                                                                                                                                              Can also be set via AUTH0_MFA_TOKEN_TTL environment variable.

                                                                                                                                                                                                                              const auth0 = new Auth0Client({
                                                                                                                                                                                                                                mfaTokenTtl: 600 // 10 minutes
                                                                                                                                                                                                                              });
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              noContentProfileResponseWhenUnauthenticated?: boolean

                                                                                                                                                                                                                              If true, the profile endpoint will return a 204 No Content response when the user is not authenticated +

                                                                                                                                                                                                                              noContentProfileResponseWhenUnauthenticated?: boolean

                                                                                                                                                                                                                              If true, the profile endpoint will return a 204 No Content response when the user is not authenticated instead of returning a 401 Unauthorized response.

                                                                                                                                                                                                                              Defaults to false.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              onCallback?: OnCallbackHook

                                                                                                                                                                                                                              A method to handle errors or manage redirects after attempting to authenticate.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              onCallback?: OnCallbackHook

                                                                                                                                                                                                                              A method to handle errors or manage redirects after attempting to authenticate.

                                                                                                                                                                                                                              See onCallback for additional details

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              pushedAuthorizationRequests?: boolean

                                                                                                                                                                                                                              If enabled, the SDK will use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              routes?: Partial<
                                                                                                                                                                                                                                  Pick<
                                                                                                                                                                                                                                      Routes,
                                                                                                                                                                                                                                      "login"
                                                                                                                                                                                                                                      | "callback"
                                                                                                                                                                                                                                      | "logout"
                                                                                                                                                                                                                                      | "backChannelLogout"
                                                                                                                                                                                                                                      | "connectAccount",
                                                                                                                                                                                                                                  >,
                                                                                                                                                                                                                              >

                                                                                                                                                                                                                              Configure the paths for the authentication routes.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              pushedAuthorizationRequests?: boolean

                                                                                                                                                                                                                              If enabled, the SDK will use the Pushed Authorization Requests (PAR) protocol when communicating with the authorization server.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              routes?: Partial<
                                                                                                                                                                                                                                  Pick<
                                                                                                                                                                                                                                      Routes,
                                                                                                                                                                                                                                      "login"
                                                                                                                                                                                                                                      | "callback"
                                                                                                                                                                                                                                      | "logout"
                                                                                                                                                                                                                                      | "backChannelLogout"
                                                                                                                                                                                                                                      | "connectAccount",
                                                                                                                                                                                                                                  >,
                                                                                                                                                                                                                              >

                                                                                                                                                                                                                              Configure the paths for the authentication routes.

                                                                                                                                                                                                                              See Custom routes for additional details.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              secret?: string

                                                                                                                                                                                                                              A 32-byte, hex-encoded secret used for encrypting cookies.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              secret?: string

                                                                                                                                                                                                                              A 32-byte, hex-encoded secret used for encrypting cookies.

                                                                                                                                                                                                                              If it's not specified, it will be loaded from the AUTH0_SECRET environment variable.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              session?: SessionConfiguration

                                                                                                                                                                                                                              Configure the session timeouts and whether to use rolling sessions or not.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              session?: SessionConfiguration

                                                                                                                                                                                                                              Configure the session timeouts and whether to use rolling sessions or not.

                                                                                                                                                                                                                              See Session configuration for additional details.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              sessionStore?: SessionDataStore

                                                                                                                                                                                                                              A custom session store implementation used to persist sessions to a data store.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              sessionStore?: SessionDataStore

                                                                                                                                                                                                                              A custom session store implementation used to persist sessions to a data store.

                                                                                                                                                                                                                              See Database sessions for additional details.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              signInReturnToPath?: string

                                                                                                                                                                                                                              The path to redirect the user to after successfully authenticating. Defaults to /.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              tokenRefreshBuffer?: number

                                                                                                                                                                                                                              Number of seconds to refresh access tokens early when calling getAccessToken. +

                                                                                                                                                                                                                              signInReturnToPath?: string

                                                                                                                                                                                                                              The path to redirect the user to after successfully authenticating. Defaults to /.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              tokenRefreshBuffer?: number

                                                                                                                                                                                                                              Number of seconds to refresh access tokens early when calling getAccessToken. This is a server-side buffer applied to token expiration checks. For example, with a buffer of 60 seconds, tokens expiring within the next minute will be refreshed proactively when a refresh token is available.

                                                                                                                                                                                                                              Defaults to 0 (no early refresh).

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              transactionCookie?: TransactionCookieOptions

                                                                                                                                                                                                                              Configure the transaction cookie used to store the state of the authentication transaction.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              useDPoP?: boolean

                                                                                                                                                                                                                              Enable DPoP (Demonstrating Proof-of-Possession) for enhanced OAuth 2.0 security.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              transactionCookie?: TransactionCookieOptions

                                                                                                                                                                                                                              Configure the transaction cookie used to store the state of the authentication transaction.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              useDPoP?: boolean

                                                                                                                                                                                                                              Enable DPoP (Demonstrating Proof-of-Possession) for enhanced OAuth 2.0 security.

                                                                                                                                                                                                                              When enabled, the SDK will:

                                                                                                                                                                                                                              • Generate DPoP proofs for token requests and protected resource requests
                                                                                                                                                                                                                                • @@ -169,4 +169,4 @@

                                                                                                                                                                                                                              RFC 9449: OAuth 2.0 Demonstrating Proof-of-Possession at the Application Layer (DPoP)

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                              diff --git a/docs/interfaces/types.Authenticator.html b/docs/interfaces/types.Authenticator.html index 8825b6507..bb4e729f8 100644 --- a/docs/interfaces/types.Authenticator.html +++ b/docs/interfaces/types.Authenticator.html @@ -1,9 +1,9 @@ -Authenticator | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Interface Authenticator

                                                                                                                                                                                                                                MFA authenticator (enrolled factor). +Authenticator | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Interface Authenticator

                                                                                                                                                                                                                                  MFA authenticator (enrolled factor). Uses camelCase for SDK-facing interface.

                                                                                                                                                                                                                                  const authenticators = await mfa.getAuthenticators({ mfaToken });

                                                                                                                                                                                                                                  const otpAuth = authenticators.find(a => a.authenticatorType === 'otp');
                                                                                                                                                                                                                                  const smsAuth = authenticators.find(a => a.oobChannel === 'sms');
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  interface Authenticator {
                                                                                                                                                                                                                                      active: boolean;
                                                                                                                                                                                                                                      authenticatorType: string;
                                                                                                                                                                                                                                      createdAt?: string;
                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                      lastAuthenticatedAt?: string;
                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                      oobChannel?: string;
                                                                                                                                                                                                                                      phoneNumber?: string;
                                                                                                                                                                                                                                      type?: string;
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  active +
                                                                                                                                                                                                                                  interface Authenticator {
                                                                                                                                                                                                                                      active: boolean;
                                                                                                                                                                                                                                      authenticatorType: string;
                                                                                                                                                                                                                                      createdAt?: string;
                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                      lastAuthenticatedAt?: string;
                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                      oobChannel?: string;
                                                                                                                                                                                                                                      phoneNumber?: string;
                                                                                                                                                                                                                                      type?: string;
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  active authenticatorType createdAt? id @@ -13,12 +13,12 @@ phoneNumber? type?

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  active: boolean

                                                                                                                                                                                                                                  Whether authenticator is active

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  authenticatorType: string

                                                                                                                                                                                                                                  Authenticator type (primary field mapped from authenticator_type)

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  createdAt?: string

                                                                                                                                                                                                                                  ISO 8601 timestamp of creation

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  id: string

                                                                                                                                                                                                                                  Authenticator ID

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  lastAuthenticatedAt?: string

                                                                                                                                                                                                                                  ISO 8601 timestamp of last authentication

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  name?: string

                                                                                                                                                                                                                                  Authenticator name (user-defined or default)

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  oobChannel?: string

                                                                                                                                                                                                                                  OOB channel (sms, voice)

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  phoneNumber?: string

                                                                                                                                                                                                                                  Phone number for OOB (masked)

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  type?: string

                                                                                                                                                                                                                                  Direct type value (optional, feature-flagged field from Auth0 API)

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  authenticatorType: string

                                                                                                                                                                                                                                  Authenticator type (primary field mapped from authenticator_type)

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  createdAt?: string

                                                                                                                                                                                                                                  ISO 8601 timestamp of creation

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  id: string

                                                                                                                                                                                                                                  Authenticator ID

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  lastAuthenticatedAt?: string

                                                                                                                                                                                                                                  ISO 8601 timestamp of last authentication

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  name?: string

                                                                                                                                                                                                                                  Authenticator name (user-defined or default)

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  oobChannel?: string

                                                                                                                                                                                                                                  OOB channel (sms, voice)

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  phoneNumber?: string

                                                                                                                                                                                                                                  Phone number for OOB (masked)

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  type?: string

                                                                                                                                                                                                                                  Direct type value (optional, feature-flagged field from Auth0 API)

                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                  diff --git a/docs/interfaces/types.AuthorizationDetails.html b/docs/interfaces/types.AuthorizationDetails.html index ff8a54f02..c6b231b71 100644 --- a/docs/interfaces/types.AuthorizationDetails.html +++ b/docs/interfaces/types.AuthorizationDetails.html @@ -1,2 +1,2 @@ -AuthorizationDetails | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Interface AuthorizationDetails

                                                                                                                                                                                                                                    interface AuthorizationDetails {
                                                                                                                                                                                                                                        type: string;
                                                                                                                                                                                                                                        readonly [parameter: string]: unknown;
                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                    • readonly [parameter: string]: unknown
                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    type -

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    type: string

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                    +AuthorizationDetails | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Interface AuthorizationDetails

                                                                                                                                                                                                                                      interface AuthorizationDetails {
                                                                                                                                                                                                                                          type: string;
                                                                                                                                                                                                                                          readonly [parameter: string]: unknown;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                      • readonly [parameter: string]: unknown
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      type +

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      type: string

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                      diff --git a/docs/interfaces/types.AuthorizationParameters.html b/docs/interfaces/types.AuthorizationParameters.html index 1f12cc3c6..6a6743807 100644 --- a/docs/interfaces/types.AuthorizationParameters.html +++ b/docs/interfaces/types.AuthorizationParameters.html @@ -1,15 +1,15 @@ -AuthorizationParameters | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Interface AuthorizationParameters

                                                                                                                                                                                                                                        interface AuthorizationParameters {
                                                                                                                                                                                                                                            audience?: string | null;
                                                                                                                                                                                                                                            max_age?: number;
                                                                                                                                                                                                                                            organization?: string;
                                                                                                                                                                                                                                            redirect_uri?: string | null;
                                                                                                                                                                                                                                            scope?: string | { [key: string]: string } | null;
                                                                                                                                                                                                                                            [key: string]: unknown;
                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                        • [key: string]: unknown

                                                                                                                                                                                                                                          Additional authorization parameters.

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        audience? +AuthorizationParameters | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Interface AuthorizationParameters

                                                                                                                                                                                                                                          interface AuthorizationParameters {
                                                                                                                                                                                                                                              audience?: string | null;
                                                                                                                                                                                                                                              max_age?: number;
                                                                                                                                                                                                                                              organization?: string;
                                                                                                                                                                                                                                              redirect_uri?: string | null;
                                                                                                                                                                                                                                              scope?: string | { [key: string]: string } | null;
                                                                                                                                                                                                                                              [key: string]: unknown;
                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                          • [key: string]: unknown

                                                                                                                                                                                                                                            Additional authorization parameters.

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          audience? max_age? organization? redirect_uri? scope?

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          audience?: string | null

                                                                                                                                                                                                                                          The unique identifier of the target API you want to access.

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          max_age?: number

                                                                                                                                                                                                                                          The maximum amount of time, in seconds, after which a user must reauthenticate.

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          organization?: string

                                                                                                                                                                                                                                          The unique identifier of the organization that the user should be logged into. +

                                                                                                                                                                                                                                          max_age?: number

                                                                                                                                                                                                                                          The maximum amount of time, in seconds, after which a user must reauthenticate.

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          organization?: string

                                                                                                                                                                                                                                          The unique identifier of the organization that the user should be logged into. When specified, the user will be prompted to log in to this specific organization. The organization ID will be included in the user's session after successful authentication.

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          redirect_uri?: string | null

                                                                                                                                                                                                                                          The URL to which the authorization server will redirect the user after granting authorization.

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          scope?: string | { [key: string]: string } | null

                                                                                                                                                                                                                                          The scope of the access request, expressed as a list of space-delimited, case-sensitive strings. +

                                                                                                                                                                                                                                          redirect_uri?: string | null

                                                                                                                                                                                                                                          The URL to which the authorization server will redirect the user after granting authorization.

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          scope?: string | { [key: string]: string } | null

                                                                                                                                                                                                                                          The scope of the access request, expressed as a list of space-delimited, case-sensitive strings. Defaults to "openid profile email offline_access".

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                          diff --git a/docs/interfaces/types.BackchannelAuthenticationOptions.html b/docs/interfaces/types.BackchannelAuthenticationOptions.html index d7b39579e..33ace4a23 100644 --- a/docs/interfaces/types.BackchannelAuthenticationOptions.html +++ b/docs/interfaces/types.BackchannelAuthenticationOptions.html @@ -1,14 +1,14 @@ -BackchannelAuthenticationOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Interface BackchannelAuthenticationOptions

                                                                                                                                                                                                                                            interface BackchannelAuthenticationOptions {
                                                                                                                                                                                                                                                authorizationDetails?: AuthorizationDetails[];
                                                                                                                                                                                                                                                authorizationParams?: AuthorizationParameters;
                                                                                                                                                                                                                                                bindingMessage: string;
                                                                                                                                                                                                                                                loginHint: { sub: string };
                                                                                                                                                                                                                                                requestedExpiry?: number;
                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            authorizationDetails? +BackchannelAuthenticationOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Interface BackchannelAuthenticationOptions

                                                                                                                                                                                                                                              interface BackchannelAuthenticationOptions {
                                                                                                                                                                                                                                                  authorizationDetails?: AuthorizationDetails[];
                                                                                                                                                                                                                                                  authorizationParams?: AuthorizationParameters;
                                                                                                                                                                                                                                                  bindingMessage: string;
                                                                                                                                                                                                                                                  loginHint: { sub: string };
                                                                                                                                                                                                                                                  requestedExpiry?: number;
                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              authorizationDetails? authorizationParams? bindingMessage loginHint requestedExpiry?

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              authorizationDetails?: AuthorizationDetails[]

                                                                                                                                                                                                                                              Optional authorization details to use Rich Authorization Requests (RAR).

                                                                                                                                                                                                                                              https://auth0.com/docs/get-started/apis/configure-rich-authorization-requests

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              authorizationParams?: AuthorizationParameters

                                                                                                                                                                                                                                              Authorization Parameters to be sent with the authorization request.

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              bindingMessage: string

                                                                                                                                                                                                                                              Human-readable message to be displayed at the consumption device and authentication device. +

                                                                                                                                                                                                                                              authorizationParams?: AuthorizationParameters

                                                                                                                                                                                                                                              Authorization Parameters to be sent with the authorization request.

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              bindingMessage: string

                                                                                                                                                                                                                                              Human-readable message to be displayed at the consumption device and authentication device. This allows the user to ensure the transaction initiated by the consumption device is the same that triggers the action on the authentication device.

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              loginHint: { sub: string }

                                                                                                                                                                                                                                              The login hint to inform which user to use.

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              loginHint: { sub: string }

                                                                                                                                                                                                                                              The login hint to inform which user to use.

                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                              • sub: string

                                                                                                                                                                                                                                                The sub claim of the user that is trying to login using Client-Initiated Backchannel Authentication, and to which a push notification to authorize the login will be sent.

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                              requestedExpiry?: number

                                                                                                                                                                                                                                              Set a custom expiry time for the CIBA flow in seconds. Defaults to 300 seconds (5 minutes) if not set.

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              requestedExpiry?: number

                                                                                                                                                                                                                                              Set a custom expiry time for the CIBA flow in seconds. Defaults to 300 seconds (5 minutes) if not set.

                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              diff --git a/docs/interfaces/types.BackchannelAuthenticationResponse.html b/docs/interfaces/types.BackchannelAuthenticationResponse.html index 03a23d8f2..7f6af7f12 100644 --- a/docs/interfaces/types.BackchannelAuthenticationResponse.html +++ b/docs/interfaces/types.BackchannelAuthenticationResponse.html @@ -1,4 +1,4 @@ -BackchannelAuthenticationResponse | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Interface BackchannelAuthenticationResponse

                                                                                                                                                                                                                                                interface BackchannelAuthenticationResponse {
                                                                                                                                                                                                                                                    authorizationDetails?: AuthorizationDetails[];
                                                                                                                                                                                                                                                    idTokenClaims?: { [key: string]: any };
                                                                                                                                                                                                                                                    tokenSet: TokenSet;
                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                authorizationDetails? +BackchannelAuthenticationResponse | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Interface BackchannelAuthenticationResponse

                                                                                                                                                                                                                                                  interface BackchannelAuthenticationResponse {
                                                                                                                                                                                                                                                      authorizationDetails?: AuthorizationDetails[];
                                                                                                                                                                                                                                                      idTokenClaims?: { [key: string]: any };
                                                                                                                                                                                                                                                      tokenSet: TokenSet;
                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  authorizationDetails? idTokenClaims? tokenSet -

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  authorizationDetails?: AuthorizationDetails[]
                                                                                                                                                                                                                                                  idTokenClaims?: { [key: string]: any }
                                                                                                                                                                                                                                                  tokenSet: TokenSet

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  authorizationDetails?: AuthorizationDetails[]
                                                                                                                                                                                                                                                  idTokenClaims?: { [key: string]: any }
                                                                                                                                                                                                                                                  tokenSet: TokenSet

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/types.ChallengeResponse.html b/docs/interfaces/types.ChallengeResponse.html index 514b7b7e1..8b99ec08b 100644 --- a/docs/interfaces/types.ChallengeResponse.html +++ b/docs/interfaces/types.ChallengeResponse.html @@ -1,12 +1,12 @@ -ChallengeResponse | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Interface ChallengeResponse

                                                                                                                                                                                                                                                    MFA challenge response. +ChallengeResponse | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Interface ChallengeResponse

                                                                                                                                                                                                                                                      MFA challenge response. Uses camelCase for SDK-facing interface.

                                                                                                                                                                                                                                                      const response = await mfa.challenge({
                                                                                                                                                                                                                                                        mfaToken,
                                                                                                                                                                                                                                                        challengeType: 'oob',
                                                                                                                                                                                                                                                        authenticatorId: 'sms|dev_abc123'
                                                                                                                                                                                                                                                      });

                                                                                                                                                                                                                                                      console.log(`Challenge type: ${response.challengeType}`);
                                                                                                                                                                                                                                                      console.log(`OOB code: ${response.oobCode}`);
                                                                                                                                                                                                                                                      console.log(`Binding method: ${response.bindingMethod}`); // 'prompt'
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      interface ChallengeResponse {
                                                                                                                                                                                                                                                          bindingMethod?: string;
                                                                                                                                                                                                                                                          challengeType: string;
                                                                                                                                                                                                                                                          oobCode?: string;
                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      bindingMethod? +
                                                                                                                                                                                                                                                      interface ChallengeResponse {
                                                                                                                                                                                                                                                          bindingMethod?: string;
                                                                                                                                                                                                                                                          challengeType: string;
                                                                                                                                                                                                                                                          oobCode?: string;
                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      bindingMethod? challengeType oobCode?

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      bindingMethod?: string

                                                                                                                                                                                                                                                      Binding method (for oob challenges)

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      challengeType: string

                                                                                                                                                                                                                                                      Challenge type (otp, oob)

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      oobCode?: string

                                                                                                                                                                                                                                                      OOB code (for oob challenges)

                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      challengeType: string

                                                                                                                                                                                                                                                      Challenge type (otp, oob)

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      oobCode?: string

                                                                                                                                                                                                                                                      OOB code (for oob challenges)

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/types.ConnectAccountOptions.html b/docs/interfaces/types.ConnectAccountOptions.html index 82d5d5d24..f623b3867 100644 --- a/docs/interfaces/types.ConnectAccountOptions.html +++ b/docs/interfaces/types.ConnectAccountOptions.html @@ -1,11 +1,11 @@ -ConnectAccountOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Interface ConnectAccountOptions

                                                                                                                                                                                                                                                        Options to initiate a connect account flow using the My Account API.

                                                                                                                                                                                                                                                        +ConnectAccountOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Interface ConnectAccountOptions

                                                                                                                                                                                                                                                          Options to initiate a connect account flow using the My Account API.

                                                                                                                                                                                                                                                          https://auth0.com/docs/manage-users/my-account-api

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          interface ConnectAccountOptions {
                                                                                                                                                                                                                                                              authorizationParams?: AuthorizationParameters;
                                                                                                                                                                                                                                                              connection: string;
                                                                                                                                                                                                                                                              returnTo?: string;
                                                                                                                                                                                                                                                              scopes?: string[];
                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          authorizationParams? +
                                                                                                                                                                                                                                                          interface ConnectAccountOptions {
                                                                                                                                                                                                                                                              authorizationParams?: AuthorizationParameters;
                                                                                                                                                                                                                                                              connection: string;
                                                                                                                                                                                                                                                              returnTo?: string;
                                                                                                                                                                                                                                                              scopes?: string[];
                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          authorizationParams? connection returnTo? scopes?

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          authorizationParams?: AuthorizationParameters

                                                                                                                                                                                                                                                          Authorization parameters to be passed to the authorization server.

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          connection: string

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

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          returnTo?: string

                                                                                                                                                                                                                                                          The URL to redirect to after successfully connecting the account.

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          scopes?: string[]

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

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          connection: string

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

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          returnTo?: string

                                                                                                                                                                                                                                                          The URL to redirect to after successfully connecting the account.

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          scopes?: string[]

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

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/types.ConnectionTokenSet.html b/docs/interfaces/types.ConnectionTokenSet.html index 698e7af18..1c14188f6 100644 --- a/docs/interfaces/types.ConnectionTokenSet.html +++ b/docs/interfaces/types.ConnectionTokenSet.html @@ -1,5 +1,5 @@ -ConnectionTokenSet | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Interface ConnectionTokenSet

                                                                                                                                                                                                                                                            interface ConnectionTokenSet {
                                                                                                                                                                                                                                                                accessToken: string;
                                                                                                                                                                                                                                                                connection: string;
                                                                                                                                                                                                                                                                expiresAt: number;
                                                                                                                                                                                                                                                                scope?: string;
                                                                                                                                                                                                                                                                [key: string]: unknown;
                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                            • [key: string]: unknown
                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            accessToken +ConnectionTokenSet | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Interface ConnectionTokenSet

                                                                                                                                                                                                                                                              interface ConnectionTokenSet {
                                                                                                                                                                                                                                                                  accessToken: string;
                                                                                                                                                                                                                                                                  connection: string;
                                                                                                                                                                                                                                                                  expiresAt: number;
                                                                                                                                                                                                                                                                  scope?: string;
                                                                                                                                                                                                                                                                  [key: string]: unknown;
                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                              • [key: string]: unknown
                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              accessToken connection expiresAt scope? -

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              accessToken: string
                                                                                                                                                                                                                                                              connection: string
                                                                                                                                                                                                                                                              expiresAt: number
                                                                                                                                                                                                                                                              scope?: string

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              accessToken: string
                                                                                                                                                                                                                                                              connection: string
                                                                                                                                                                                                                                                              expiresAt: number
                                                                                                                                                                                                                                                              scope?: string

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/types.CookieOptions.html b/docs/interfaces/types.CookieOptions.html index 606316a1e..741e55ad1 100644 --- a/docs/interfaces/types.CookieOptions.html +++ b/docs/interfaces/types.CookieOptions.html @@ -1,8 +1,8 @@ -CookieOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Interface CookieOptions

                                                                                                                                                                                                                                                                interface CookieOptions {
                                                                                                                                                                                                                                                                    domain?: string;
                                                                                                                                                                                                                                                                    httpOnly: boolean;
                                                                                                                                                                                                                                                                    maxAge?: number;
                                                                                                                                                                                                                                                                    path: string;
                                                                                                                                                                                                                                                                    sameSite: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                    secure: boolean;
                                                                                                                                                                                                                                                                    transient?: boolean;
                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                domain? +CookieOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Interface CookieOptions

                                                                                                                                                                                                                                                                  interface CookieOptions {
                                                                                                                                                                                                                                                                      domain?: string;
                                                                                                                                                                                                                                                                      httpOnly: boolean;
                                                                                                                                                                                                                                                                      maxAge?: number;
                                                                                                                                                                                                                                                                      path: string;
                                                                                                                                                                                                                                                                      sameSite: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                      secure: boolean;
                                                                                                                                                                                                                                                                      transient?: boolean;
                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  domain? httpOnly maxAge? path sameSite secure transient? -

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  domain?: string
                                                                                                                                                                                                                                                                  httpOnly: boolean
                                                                                                                                                                                                                                                                  maxAge?: number
                                                                                                                                                                                                                                                                  path: string
                                                                                                                                                                                                                                                                  sameSite: "lax" | "strict" | "none"
                                                                                                                                                                                                                                                                  secure: boolean
                                                                                                                                                                                                                                                                  transient?: boolean

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  domain?: string
                                                                                                                                                                                                                                                                  httpOnly: boolean
                                                                                                                                                                                                                                                                  maxAge?: number
                                                                                                                                                                                                                                                                  path: string
                                                                                                                                                                                                                                                                  sameSite: "lax" | "strict" | "none"
                                                                                                                                                                                                                                                                  secure: boolean
                                                                                                                                                                                                                                                                  transient?: boolean

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/types.CustomTokenExchangeOptions.html b/docs/interfaces/types.CustomTokenExchangeOptions.html index 315ca8678..4456a7a96 100644 --- a/docs/interfaces/types.CustomTokenExchangeOptions.html +++ b/docs/interfaces/types.CustomTokenExchangeOptions.html @@ -1,9 +1,9 @@ -CustomTokenExchangeOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Interface CustomTokenExchangeOptions

                                                                                                                                                                                                                                                                    Options for Custom Token Exchange.

                                                                                                                                                                                                                                                                    +CustomTokenExchangeOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Interface CustomTokenExchangeOptions

                                                                                                                                                                                                                                                                      Options for Custom Token Exchange.

                                                                                                                                                                                                                                                                      Custom Token Exchange allows exchanging external tokens for Auth0 tokens without a browser redirect. The external token is validated by an Auth0 Action with the Custom Token Exchange trigger.

                                                                                                                                                                                                                                                                      Auth0 Custom Token Exchange Documentation

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      interface CustomTokenExchangeOptions {
                                                                                                                                                                                                                                                                          actorToken?: string;
                                                                                                                                                                                                                                                                          actorTokenType?: string;
                                                                                                                                                                                                                                                                          additionalParameters?: Record<string, unknown>;
                                                                                                                                                                                                                                                                          audience?: string;
                                                                                                                                                                                                                                                                          organization?: string;
                                                                                                                                                                                                                                                                          scope?: string;
                                                                                                                                                                                                                                                                          subjectToken: string;
                                                                                                                                                                                                                                                                          subjectTokenType: string;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      actorToken? +
                                                                                                                                                                                                                                                                      interface CustomTokenExchangeOptions {
                                                                                                                                                                                                                                                                          actorToken?: string;
                                                                                                                                                                                                                                                                          actorTokenType?: string;
                                                                                                                                                                                                                                                                          additionalParameters?: Record<string, unknown>;
                                                                                                                                                                                                                                                                          audience?: string;
                                                                                                                                                                                                                                                                          organization?: string;
                                                                                                                                                                                                                                                                          scope?: string;
                                                                                                                                                                                                                                                                          subjectToken: string;
                                                                                                                                                                                                                                                                          subjectTokenType: string;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      actorToken? actorTokenType? additionalParameters? audience? @@ -14,20 +14,20 @@

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      actorToken?: string

                                                                                                                                                                                                                                                                      Actor token for delegation/impersonation scenarios (RFC 8693). Represents the identity of the acting party.

                                                                                                                                                                                                                                                                      If provided, actorTokenType is required.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      actorTokenType?: string

                                                                                                                                                                                                                                                                      Actor token type URI (required if actorToken is provided).

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      additionalParameters?: Record<string, unknown>

                                                                                                                                                                                                                                                                      Additional custom parameters passed to the token endpoint. +

                                                                                                                                                                                                                                                                      actorTokenType?: string

                                                                                                                                                                                                                                                                      Actor token type URI (required if actorToken is provided).

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      additionalParameters?: Record<string, unknown>

                                                                                                                                                                                                                                                                      Additional custom parameters passed to the token endpoint. Accessible in Auth0 Action via event.request.body.

                                                                                                                                                                                                                                                                      Use this for custom parameters instead of index signature to avoid TypeScript issues.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      audience?: string

                                                                                                                                                                                                                                                                      The unique identifier of the target API.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      organization?: string

                                                                                                                                                                                                                                                                      Organization ID or name for multi-tenant scenarios. +

                                                                                                                                                                                                                                                                      audience?: string

                                                                                                                                                                                                                                                                      The unique identifier of the target API.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      organization?: string

                                                                                                                                                                                                                                                                      Organization ID or name for multi-tenant scenarios. The organization ID will be present in the resulting access token claims.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      scope?: string

                                                                                                                                                                                                                                                                      Space-delimited OAuth 2.0 scopes.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      scope?: string

                                                                                                                                                                                                                                                                      Space-delimited OAuth 2.0 scopes.

                                                                                                                                                                                                                                                                      Note: These scopes are merged with SDK default scopes (openid profile email offline_access). Duplicates are removed.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      subjectToken: string

                                                                                                                                                                                                                                                                      The external token being exchanged. +

                                                                                                                                                                                                                                                                      subjectToken: string

                                                                                                                                                                                                                                                                      The external token being exchanged. This will be validated by your Auth0 Action with the Custom Token Exchange trigger.

                                                                                                                                                                                                                                                                      Validation: Must be a non-empty string.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      subjectTokenType: string

                                                                                                                                                                                                                                                                      Custom URI identifying the token type.

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      subjectTokenType: string

                                                                                                                                                                                                                                                                      Custom URI identifying the token type.

                                                                                                                                                                                                                                                                      Validation Rules:

                                                                                                                                                                                                                                                                      • Must be 10-100 characters
                                                                                                                                                                                                                                                                        • @@ -40,4 +40,4 @@ 
                                                                                                                                                                                                                                                                      'https://mycompany.com/token-type/v1'
                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/types.CustomTokenExchangeResponse.html b/docs/interfaces/types.CustomTokenExchangeResponse.html index a8bc00b20..20b40f4c4 100644 --- a/docs/interfaces/types.CustomTokenExchangeResponse.html +++ b/docs/interfaces/types.CustomTokenExchangeResponse.html @@ -1,14 +1,14 @@ -CustomTokenExchangeResponse | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Interface CustomTokenExchangeResponse

                                                                                                                                                                                                                                                                        Response from Custom Token Exchange.

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        interface CustomTokenExchangeResponse {
                                                                                                                                                                                                                                                                            accessToken: string;
                                                                                                                                                                                                                                                                            expiresIn: number;
                                                                                                                                                                                                                                                                            idToken?: string;
                                                                                                                                                                                                                                                                            refreshToken?: string;
                                                                                                                                                                                                                                                                            scope?: string;
                                                                                                                                                                                                                                                                            tokenType: string;
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        accessToken +CustomTokenExchangeResponse | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Interface CustomTokenExchangeResponse

                                                                                                                                                                                                                                                                          Response from Custom Token Exchange.

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          interface CustomTokenExchangeResponse {
                                                                                                                                                                                                                                                                              accessToken: string;
                                                                                                                                                                                                                                                                              expiresIn: number;
                                                                                                                                                                                                                                                                              idToken?: string;
                                                                                                                                                                                                                                                                              refreshToken?: string;
                                                                                                                                                                                                                                                                              scope?: string;
                                                                                                                                                                                                                                                                              tokenType: string;
                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          accessToken expiresIn idToken? refreshToken? scope? tokenType

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          accessToken: string

                                                                                                                                                                                                                                                                          The access token issued by Auth0

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          expiresIn: number

                                                                                                                                                                                                                                                                          Token lifetime in seconds

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          idToken?: string

                                                                                                                                                                                                                                                                          The ID token, if openid scope was requested

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          refreshToken?: string

                                                                                                                                                                                                                                                                          The refresh token, if offline_access scope was requested

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          scope?: string

                                                                                                                                                                                                                                                                          Granted scopes

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          tokenType: string

                                                                                                                                                                                                                                                                          Token type, typically "Bearer" or "DPoP"

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          expiresIn: number

                                                                                                                                                                                                                                                                          Token lifetime in seconds

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          idToken?: string

                                                                                                                                                                                                                                                                          The ID token, if openid scope was requested

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          refreshToken?: string

                                                                                                                                                                                                                                                                          The refresh token, if offline_access scope was requested

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          scope?: string

                                                                                                                                                                                                                                                                          Granted scopes

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          tokenType: string

                                                                                                                                                                                                                                                                          Token type, typically "Bearer" or "DPoP"

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/types.DiscoveryCacheOptions.html b/docs/interfaces/types.DiscoveryCacheOptions.html index 644ecc6e8..51130b349 100644 --- a/docs/interfaces/types.DiscoveryCacheOptions.html +++ b/docs/interfaces/types.DiscoveryCacheOptions.html @@ -1,10 +1,10 @@ -DiscoveryCacheOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Interface DiscoveryCacheOptions

                                                                                                                                                                                                                                                                            Configuration for the OIDC discovery metadata cache. +DiscoveryCacheOptions | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Interface DiscoveryCacheOptions

                                                                                                                                                                                                                                                                              Configuration for the OIDC discovery metadata cache. Applies in both static and resolver modes.

                                                                                                                                                                                                                                                                              const auth0 = new Auth0Client({
                                                                                                                                                                                                                                                                                domain: myDomainResolver,
                                                                                                                                                                                                                                                                                discoveryCache: {
                                                                                                                                                                                                                                                                                  ttl: 300,        // 5-minute TTL
                                                                                                                                                                                                                                                                                  maxEntries: 50,  // Cache up to 50 issuers
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              interface DiscoveryCacheOptions {
                                                                                                                                                                                                                                                                                  maxEntries?: number;
                                                                                                                                                                                                                                                                                  ttl?: number;
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              maxEntries? +
                                                                                                                                                                                                                                                                              interface DiscoveryCacheOptions {
                                                                                                                                                                                                                                                                                  maxEntries?: number;
                                                                                                                                                                                                                                                                                  ttl?: number;
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              maxEntries? ttl?

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              maxEntries?: number

                                                                                                                                                                                                                                                                              Maximum number of cached issuers. Default: 100. LRU eviction.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              ttl?: number

                                                                                                                                                                                                                                                                              Time-to-live for cached discovery metadata in seconds. Default: 600 (10 minutes).

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              ttl?: number

                                                                                                                                                                                                                                                                              Time-to-live for cached discovery metadata in seconds. Default: 600 (10 minutes).

                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/types.EnrollOobOptions.html b/docs/interfaces/types.EnrollOobOptions.html index 682cc9fe9..180b7a685 100644 --- a/docs/interfaces/types.EnrollOobOptions.html +++ b/docs/interfaces/types.EnrollOobOptions.html @@ -1,12 +1,12 @@ -EnrollOobOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Interface EnrollOobOptions

                                                                                                                                                                                                                                                                                Enroll OOB authenticator (SMS/Voice/Push/Email).

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                interface EnrollOobOptions {
                                                                                                                                                                                                                                                                                    authenticatorTypes: ["oob"];
                                                                                                                                                                                                                                                                                    email?: string;
                                                                                                                                                                                                                                                                                    mfaToken: string;
                                                                                                                                                                                                                                                                                    oobChannels: ("email" | "sms" | "voice" | "auth0")[];
                                                                                                                                                                                                                                                                                    phoneNumber?: string;
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                authenticatorTypes +EnrollOobOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Interface EnrollOobOptions

                                                                                                                                                                                                                                                                                  Enroll OOB authenticator (SMS/Voice/Push/Email).

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  interface EnrollOobOptions {
                                                                                                                                                                                                                                                                                      authenticatorTypes: ["oob"];
                                                                                                                                                                                                                                                                                      email?: string;
                                                                                                                                                                                                                                                                                      mfaToken: string;
                                                                                                                                                                                                                                                                                      oobChannels: ("email" | "sms" | "voice" | "auth0")[];
                                                                                                                                                                                                                                                                                      phoneNumber?: string;
                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  authenticatorTypes email? mfaToken oobChannels phoneNumber?

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  authenticatorTypes: ["oob"]

                                                                                                                                                                                                                                                                                  Authenticator types to enroll

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  email?: string

                                                                                                                                                                                                                                                                                  Email address (optional for email channel - uses user's email if not provided)

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  mfaToken: string

                                                                                                                                                                                                                                                                                  Encrypted MFA token

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  oobChannels: ("email" | "sms" | "voice" | "auth0")[]

                                                                                                                                                                                                                                                                                  OOB channels (sms, voice, auth0, email)

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  phoneNumber?: string

                                                                                                                                                                                                                                                                                  Phone number in E.164 format (required for sms/voice)

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  email?: string

                                                                                                                                                                                                                                                                                  Email address (optional for email channel - uses user's email if not provided)

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  mfaToken: string

                                                                                                                                                                                                                                                                                  Encrypted MFA token

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  oobChannels: ("email" | "sms" | "voice" | "auth0")[]

                                                                                                                                                                                                                                                                                  OOB channels (sms, voice, auth0, email)

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  phoneNumber?: string

                                                                                                                                                                                                                                                                                  Phone number in E.164 format (required for sms/voice)

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/types.EnrollOtpOptions.html b/docs/interfaces/types.EnrollOtpOptions.html index ce037047c..97b980f02 100644 --- a/docs/interfaces/types.EnrollOtpOptions.html +++ b/docs/interfaces/types.EnrollOtpOptions.html @@ -1,6 +1,6 @@ -EnrollOtpOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Interface EnrollOtpOptions

                                                                                                                                                                                                                                                                                    Enroll OTP authenticator (TOTP app like Authy/Google Authenticator).

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    interface EnrollOtpOptions {
                                                                                                                                                                                                                                                                                        authenticatorTypes: ["otp"];
                                                                                                                                                                                                                                                                                        mfaToken: string;
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    authenticatorTypes +EnrollOtpOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Interface EnrollOtpOptions

                                                                                                                                                                                                                                                                                      Enroll OTP authenticator (TOTP app like Authy/Google Authenticator).

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      interface EnrollOtpOptions {
                                                                                                                                                                                                                                                                                          authenticatorTypes: ["otp"];
                                                                                                                                                                                                                                                                                          mfaToken: string;
                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      authenticatorTypes mfaToken

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      authenticatorTypes: ["otp"]

                                                                                                                                                                                                                                                                                      Authenticator types to enroll

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      mfaToken: string

                                                                                                                                                                                                                                                                                      Encrypted MFA token

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      mfaToken: string

                                                                                                                                                                                                                                                                                      Encrypted MFA token

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/types.MCDMetadata.html b/docs/interfaces/types.MCDMetadata.html index 89ba57cf2..80332be5a 100644 --- a/docs/interfaces/types.MCDMetadata.html +++ b/docs/interfaces/types.MCDMetadata.html @@ -1,7 +1,7 @@ -MCDMetadata | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Interface MCDMetadataInternal

                                                                                                                                                                                                                                                                                        Metadata for a specific domain and its associated issuer. +MCDMetadata | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Interface MCDMetadataInternal

                                                                                                                                                                                                                                                                                          Metadata for a specific domain and its associated issuer. Stored in session internal state to track which domain authenticated the user.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          interface MCDMetadata {
                                                                                                                                                                                                                                                                                              domain: string;
                                                                                                                                                                                                                                                                                              issuer: string;
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          domain +
                                                                                                                                                                                                                                                                                          interface MCDMetadata {
                                                                                                                                                                                                                                                                                              domain: string;
                                                                                                                                                                                                                                                                                              issuer: string;
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          domain issuer

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          domain: string

                                                                                                                                                                                                                                                                                          The Auth0 domain that authenticated the user

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          issuer: string

                                                                                                                                                                                                                                                                                          The OIDC issuer URL for the domain

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          issuer: string

                                                                                                                                                                                                                                                                                          The OIDC issuer URL for the domain

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/types.MfaClient.html b/docs/interfaces/types.MfaClient.html index e042ac8e7..05b1de94e 100644 --- a/docs/interfaces/types.MfaClient.html +++ b/docs/interfaces/types.MfaClient.html @@ -1,20 +1,20 @@ -MfaClient | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Interface MfaClient

                                                                                                                                                                                                                                                                                            MFA client interface available in both server and client contexts.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            interface MfaClient {
                                                                                                                                                                                                                                                                                                challenge(
                                                                                                                                                                                                                                                                                                    options: {
                                                                                                                                                                                                                                                                                                        authenticatorId?: string;
                                                                                                                                                                                                                                                                                                        challengeType: string;
                                                                                                                                                                                                                                                                                                        mfaToken: string;
                                                                                                                                                                                                                                                                                                    },
                                                                                                                                                                                                                                                                                                ): Promise<ChallengeResponse>;
                                                                                                                                                                                                                                                                                                enroll(options: EnrollOptions): Promise<EnrollmentResponse>;
                                                                                                                                                                                                                                                                                                getAuthenticators(options: { mfaToken: string }): Promise<Authenticator[]>;
                                                                                                                                                                                                                                                                                                verify(options: VerifyMfaOptions): Promise<MfaVerifyResponse>;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                            challenge +MfaClient | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Interface MfaClient

                                                                                                                                                                                                                                                                                              MFA client interface available in both server and client contexts.

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              interface MfaClient {
                                                                                                                                                                                                                                                                                                  challenge(
                                                                                                                                                                                                                                                                                                      options: {
                                                                                                                                                                                                                                                                                                          authenticatorId?: string;
                                                                                                                                                                                                                                                                                                          challengeType: string;
                                                                                                                                                                                                                                                                                                          mfaToken: string;
                                                                                                                                                                                                                                                                                                      },
                                                                                                                                                                                                                                                                                                  ): Promise<ChallengeResponse>;
                                                                                                                                                                                                                                                                                                  enroll(options: EnrollOptions): Promise<EnrollmentResponse>;
                                                                                                                                                                                                                                                                                                  getAuthenticators(options: { mfaToken: string }): Promise<Authenticator[]>;
                                                                                                                                                                                                                                                                                                  verify(options: VerifyMfaOptions): Promise<MfaVerifyResponse>;
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                              challenge enroll getAuthenticators verify

                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                              • Initiate an MFA challenge.

                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                • options: { authenticatorId?: string; challengeType: string; mfaToken: string }

                                                                                                                                                                                                                                                                                                  Challenge options

                                                                                                                                                                                                                                                                                                Returns Promise<ChallengeResponse>

                                                                                                                                                                                                                                                                                                Challenge response (oobCode, bindingMethod)

                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                              • List enrolled authenticators for the user. Filters by allowed challenge types from mfa_requirements.

                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                • options: { mfaToken: string }

                                                                                                                                                                                                                                                                                                  Options containing encrypted mfaToken

                                                                                                                                                                                                                                                                                                Returns Promise<Authenticator[]>

                                                                                                                                                                                                                                                                                                Array of authenticators

                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/types.MfaContext.html b/docs/interfaces/types.MfaContext.html index 19f945153..28a583739 100644 --- a/docs/interfaces/types.MfaContext.html +++ b/docs/interfaces/types.MfaContext.html @@ -1,13 +1,13 @@ -MfaContext | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Interface MfaContext

                                                                                                                                                                                                                                                                                                MFA context embedded in encrypted token. +MfaContext | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Interface MfaContext

                                                                                                                                                                                                                                                                                                  MFA context embedded in encrypted token. Self-contained with all information needed for challenge completion.

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  interface MfaContext {
                                                                                                                                                                                                                                                                                                      audience: string;
                                                                                                                                                                                                                                                                                                      createdAt: number;
                                                                                                                                                                                                                                                                                                      mfaRequirements: MfaRequirements | undefined;
                                                                                                                                                                                                                                                                                                      mfaToken: string;
                                                                                                                                                                                                                                                                                                      scope: string;
                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  audience +
                                                                                                                                                                                                                                                                                                  interface MfaContext {
                                                                                                                                                                                                                                                                                                      audience: string;
                                                                                                                                                                                                                                                                                                      createdAt: number;
                                                                                                                                                                                                                                                                                                      mfaRequirements: MfaRequirements | undefined;
                                                                                                                                                                                                                                                                                                      mfaToken: string;
                                                                                                                                                                                                                                                                                                      scope: string;
                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  audience createdAt mfaRequirements mfaToken scope

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  audience: string

                                                                                                                                                                                                                                                                                                  API identifier that required MFA

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  createdAt: number

                                                                                                                                                                                                                                                                                                  Timestamp for TTL validation (milliseconds since epoch)

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  mfaRequirements: MfaRequirements | undefined

                                                                                                                                                                                                                                                                                                  MFA requirements from Auth0

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  mfaToken: string

                                                                                                                                                                                                                                                                                                  Raw mfa_token from Auth0

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  scope: string

                                                                                                                                                                                                                                                                                                  Scopes requested

                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  createdAt: number

                                                                                                                                                                                                                                                                                                  Timestamp for TTL validation (milliseconds since epoch)

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  mfaRequirements: MfaRequirements | undefined

                                                                                                                                                                                                                                                                                                  MFA requirements from Auth0

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  mfaToken: string

                                                                                                                                                                                                                                                                                                  Raw mfa_token from Auth0

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  scope: string

                                                                                                                                                                                                                                                                                                  Scopes requested

                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/types.MfaVerifyResponse.html b/docs/interfaces/types.MfaVerifyResponse.html index 638ee86e5..b7c325599 100644 --- a/docs/interfaces/types.MfaVerifyResponse.html +++ b/docs/interfaces/types.MfaVerifyResponse.html @@ -1,7 +1,7 @@ -MfaVerifyResponse | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Interface MfaVerifyResponse

                                                                                                                                                                                                                                                                                                    MFA verify response from Auth0. +MfaVerifyResponse | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Interface MfaVerifyResponse

                                                                                                                                                                                                                                                                                                      MFA verify response from Auth0. Uses snake_case to match Auth0 API and SPA SDK conventions.

                                                                                                                                                                                                                                                                                                      https://auth0.com/docs/api/authentication#verify-with-one-time-password-otp-

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      interface MfaVerifyResponse {
                                                                                                                                                                                                                                                                                                          access_token: string;
                                                                                                                                                                                                                                                                                                          audience?: string;
                                                                                                                                                                                                                                                                                                          expires_in: number;
                                                                                                                                                                                                                                                                                                          id_token?: string;
                                                                                                                                                                                                                                                                                                          recovery_code?: string;
                                                                                                                                                                                                                                                                                                          refresh_token?: string;
                                                                                                                                                                                                                                                                                                          scope?: string;
                                                                                                                                                                                                                                                                                                          token_type: string;
                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      access_token +
                                                                                                                                                                                                                                                                                                      interface MfaVerifyResponse {
                                                                                                                                                                                                                                                                                                          access_token: string;
                                                                                                                                                                                                                                                                                                          audience?: string;
                                                                                                                                                                                                                                                                                                          expires_in: number;
                                                                                                                                                                                                                                                                                                          id_token?: string;
                                                                                                                                                                                                                                                                                                          recovery_code?: string;
                                                                                                                                                                                                                                                                                                          refresh_token?: string;
                                                                                                                                                                                                                                                                                                          scope?: string;
                                                                                                                                                                                                                                                                                                          token_type: string;
                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      access_token audience? expires_in id_token? @@ -10,11 +10,11 @@ scope? token_type

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      access_token: string

                                                                                                                                                                                                                                                                                                      Access token

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      audience?: string

                                                                                                                                                                                                                                                                                                      API audience

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      expires_in: number

                                                                                                                                                                                                                                                                                                      Expires in seconds

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      id_token?: string

                                                                                                                                                                                                                                                                                                      ID token (if present)

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      recovery_code?: string

                                                                                                                                                                                                                                                                                                      Recovery code (if regenerated by tenant config)

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      refresh_token?: string

                                                                                                                                                                                                                                                                                                      Refresh token (if present)

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      scope?: string

                                                                                                                                                                                                                                                                                                      Token scope

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      token_type: string

                                                                                                                                                                                                                                                                                                      Token type (usually "Bearer")

                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      audience?: string

                                                                                                                                                                                                                                                                                                      API audience

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      expires_in: number

                                                                                                                                                                                                                                                                                                      Expires in seconds

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      id_token?: string

                                                                                                                                                                                                                                                                                                      ID token (if present)

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      recovery_code?: string

                                                                                                                                                                                                                                                                                                      Recovery code (if regenerated by tenant config)

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      refresh_token?: string

                                                                                                                                                                                                                                                                                                      Refresh token (if present)

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      scope?: string

                                                                                                                                                                                                                                                                                                      Token scope

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      token_type: string

                                                                                                                                                                                                                                                                                                      Token type (usually "Bearer")

                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/types.Routes.html b/docs/interfaces/types.Routes.html index 3530c5391..c36157134 100644 --- a/docs/interfaces/types.Routes.html +++ b/docs/interfaces/types.Routes.html @@ -1,4 +1,4 @@ -Routes | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Interface Routes

                                                                                                                                                                                                                                                                                                        interface Routes {
                                                                                                                                                                                                                                                                                                            accessToken: string;
                                                                                                                                                                                                                                                                                                            backChannelLogout: string;
                                                                                                                                                                                                                                                                                                            callback: string;
                                                                                                                                                                                                                                                                                                            connectAccount: string;
                                                                                                                                                                                                                                                                                                            login: string;
                                                                                                                                                                                                                                                                                                            logout: string;
                                                                                                                                                                                                                                                                                                            mfaAuthenticators: string;
                                                                                                                                                                                                                                                                                                            mfaChallenge: string;
                                                                                                                                                                                                                                                                                                            mfaEnroll: string;
                                                                                                                                                                                                                                                                                                            mfaVerify: string;
                                                                                                                                                                                                                                                                                                            profile: string;
                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        accessToken +Routes | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Interface Routes

                                                                                                                                                                                                                                                                                                          interface Routes {
                                                                                                                                                                                                                                                                                                              accessToken: string;
                                                                                                                                                                                                                                                                                                              backChannelLogout: string;
                                                                                                                                                                                                                                                                                                              callback: string;
                                                                                                                                                                                                                                                                                                              connectAccount: string;
                                                                                                                                                                                                                                                                                                              login: string;
                                                                                                                                                                                                                                                                                                              logout: string;
                                                                                                                                                                                                                                                                                                              mfaAuthenticators: string;
                                                                                                                                                                                                                                                                                                              mfaChallenge: string;
                                                                                                                                                                                                                                                                                                              mfaEnroll: string;
                                                                                                                                                                                                                                                                                                              mfaVerify: string;
                                                                                                                                                                                                                                                                                                              profile: string;
                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          accessToken backChannelLogout callback connectAccount @@ -9,4 +9,4 @@ mfaEnroll mfaVerify profile -

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          accessToken: string
                                                                                                                                                                                                                                                                                                          backChannelLogout: string
                                                                                                                                                                                                                                                                                                          callback: string
                                                                                                                                                                                                                                                                                                          connectAccount: string
                                                                                                                                                                                                                                                                                                          login: string
                                                                                                                                                                                                                                                                                                          logout: string
                                                                                                                                                                                                                                                                                                          mfaAuthenticators: string
                                                                                                                                                                                                                                                                                                          mfaChallenge: string
                                                                                                                                                                                                                                                                                                          mfaEnroll: string
                                                                                                                                                                                                                                                                                                          mfaVerify: string
                                                                                                                                                                                                                                                                                                          profile: string

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          accessToken: string
                                                                                                                                                                                                                                                                                                          backChannelLogout: string
                                                                                                                                                                                                                                                                                                          callback: string
                                                                                                                                                                                                                                                                                                          connectAccount: string
                                                                                                                                                                                                                                                                                                          login: string
                                                                                                                                                                                                                                                                                                          logout: string
                                                                                                                                                                                                                                                                                                          mfaAuthenticators: string
                                                                                                                                                                                                                                                                                                          mfaChallenge: string
                                                                                                                                                                                                                                                                                                          mfaEnroll: string
                                                                                                                                                                                                                                                                                                          mfaVerify: string
                                                                                                                                                                                                                                                                                                          profile: string

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/types.SessionConfiguration.html b/docs/interfaces/types.SessionConfiguration.html index daba376d2..9fea92ca3 100644 --- a/docs/interfaces/types.SessionConfiguration.html +++ b/docs/interfaces/types.SessionConfiguration.html @@ -1,16 +1,16 @@ -SessionConfiguration | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Interface SessionConfiguration

                                                                                                                                                                                                                                                                                                            interface SessionConfiguration {
                                                                                                                                                                                                                                                                                                                absoluteDuration?: number;
                                                                                                                                                                                                                                                                                                                cookie?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                inactivityDuration?: number;
                                                                                                                                                                                                                                                                                                                rolling?: boolean;
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            absoluteDuration? +SessionConfiguration | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                              Interface SessionConfiguration

                                                                                                                                                                                                                                                                                                              interface SessionConfiguration {
                                                                                                                                                                                                                                                                                                                  absoluteDuration?: number;
                                                                                                                                                                                                                                                                                                                  cookie?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                  inactivityDuration?: number;
                                                                                                                                                                                                                                                                                                                  rolling?: boolean;
                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              absoluteDuration? cookie? inactivityDuration? rolling?

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              absoluteDuration?: number

                                                                                                                                                                                                                                                                                                              The absolute duration after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                              Once the absolute duration has been reached, the session will no longer be extended.

                                                                                                                                                                                                                                                                                                              Default: 3 days.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              cookie?: SessionCookieOptions

                                                                                                                                                                                                                                                                                                              The options for the session cookie.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              inactivityDuration?: number

                                                                                                                                                                                                                                                                                                              The duration of inactivity after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              cookie?: SessionCookieOptions

                                                                                                                                                                                                                                                                                                              The options for the session cookie.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              inactivityDuration?: number

                                                                                                                                                                                                                                                                                                              The duration of inactivity after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                              The session will be extended as long as it was active before the inactivity duration has been reached.

                                                                                                                                                                                                                                                                                                              Default: 1 day.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              rolling?: boolean

                                                                                                                                                                                                                                                                                                              A boolean indicating whether rolling sessions should be used or not.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              rolling?: boolean

                                                                                                                                                                                                                                                                                                              A boolean indicating whether rolling sessions should be used or not.

                                                                                                                                                                                                                                                                                                              When enabled, the session will continue to be extended as long as it is used within the inactivity duration. Once the upper bound, set via the absoluteDuration, has been reached, the session will no longer be extended.

                                                                                                                                                                                                                                                                                                              Default: true.

                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/types.SessionCookieOptions.html b/docs/interfaces/types.SessionCookieOptions.html index ae8181a99..c717de972 100644 --- a/docs/interfaces/types.SessionCookieOptions.html +++ b/docs/interfaces/types.SessionCookieOptions.html @@ -1,4 +1,4 @@ -SessionCookieOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                Interface SessionCookieOptions

                                                                                                                                                                                                                                                                                                                interface SessionCookieOptions {
                                                                                                                                                                                                                                                                                                                    domain?: string;
                                                                                                                                                                                                                                                                                                                    name?: string;
                                                                                                                                                                                                                                                                                                                    path?: string;
                                                                                                                                                                                                                                                                                                                    sameSite?: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                                                                    secure?: boolean;
                                                                                                                                                                                                                                                                                                                    transient?: boolean;
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                domain? +SessionCookieOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                  Interface SessionCookieOptions

                                                                                                                                                                                                                                                                                                                  interface SessionCookieOptions {
                                                                                                                                                                                                                                                                                                                      domain?: string;
                                                                                                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                      sameSite?: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                                                                      secure?: boolean;
                                                                                                                                                                                                                                                                                                                      transient?: boolean;
                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  domain? name? path? sameSite? @@ -7,12 +7,12 @@

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  domain?: string

                                                                                                                                                                                                                                                                                                                  Specifies the value for the Set-Cookie attribute. By default, no domain is set, and most clients will consider the cookie to apply to only the current domain.

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  name?: string

                                                                                                                                                                                                                                                                                                                  The name of the session cookie.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  name?: string

                                                                                                                                                                                                                                                                                                                  The name of the session cookie.

                                                                                                                                                                                                                                                                                                                  Default: __session.

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                  The path attribute of the session cookie. Will be set to '/' by default.

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  sameSite?: "lax" | "strict" | "none"

                                                                                                                                                                                                                                                                                                                  The sameSite attribute of the session cookie.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  path?: string

                                                                                                                                                                                                                                                                                                                  The path attribute of the session cookie. Will be set to '/' by default.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  sameSite?: "lax" | "strict" | "none"

                                                                                                                                                                                                                                                                                                                  The sameSite attribute of the session cookie.

                                                                                                                                                                                                                                                                                                                  Default: lax.

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  secure?: boolean

                                                                                                                                                                                                                                                                                                                  The secure attribute of the session cookie.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  secure?: boolean

                                                                                                                                                                                                                                                                                                                  The secure attribute of the session cookie.

                                                                                                                                                                                                                                                                                                                  Default: depends on the protocol of the application's base URL. If the protocol is https, then true, otherwise false.

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  transient?: boolean

                                                                                                                                                                                                                                                                                                                  The transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.

                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  transient?: boolean

                                                                                                                                                                                                                                                                                                                  The transient attribute of the session cookie. When true, the cookie will not persist beyond the current session.

                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/types.SessionData.html b/docs/interfaces/types.SessionData.html index 4b145743c..5bc00cd88 100644 --- a/docs/interfaces/types.SessionData.html +++ b/docs/interfaces/types.SessionData.html @@ -1,6 +1,6 @@ -SessionData | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Interface SessionData

                                                                                                                                                                                                                                                                                                                    interface SessionData {
                                                                                                                                                                                                                                                                                                                        accessTokens?: AccessTokenSet[];
                                                                                                                                                                                                                                                                                                                        connectionTokenSets?: ConnectionTokenSet[];
                                                                                                                                                                                                                                                                                                                        internal: { createdAt: number; mcd?: MCDMetadata; sid: string };
                                                                                                                                                                                                                                                                                                                        tokenSet: TokenSet;
                                                                                                                                                                                                                                                                                                                        user: User;
                                                                                                                                                                                                                                                                                                                        [key: string]: unknown;
                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                    • [key: string]: unknown
                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    accessTokens? +SessionData | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Interface SessionData

                                                                                                                                                                                                                                                                                                                      interface SessionData {
                                                                                                                                                                                                                                                                                                                          accessTokens?: AccessTokenSet[];
                                                                                                                                                                                                                                                                                                                          connectionTokenSets?: ConnectionTokenSet[];
                                                                                                                                                                                                                                                                                                                          internal: { createdAt: number; mcd?: MCDMetadata; sid: string };
                                                                                                                                                                                                                                                                                                                          tokenSet: TokenSet;
                                                                                                                                                                                                                                                                                                                          user: User;
                                                                                                                                                                                                                                                                                                                          [key: string]: unknown;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                      • [key: string]: unknown
                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      accessTokens? connectionTokenSets? internal tokenSet user -

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      accessTokens?: AccessTokenSet[]
                                                                                                                                                                                                                                                                                                                      connectionTokenSets?: ConnectionTokenSet[]
                                                                                                                                                                                                                                                                                                                      internal: { createdAt: number; mcd?: MCDMetadata; sid: string }
                                                                                                                                                                                                                                                                                                                      tokenSet: TokenSet
                                                                                                                                                                                                                                                                                                                      user: User

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      accessTokens?: AccessTokenSet[]
                                                                                                                                                                                                                                                                                                                      connectionTokenSets?: ConnectionTokenSet[]
                                                                                                                                                                                                                                                                                                                      internal: { createdAt: number; mcd?: MCDMetadata; sid: string }
                                                                                                                                                                                                                                                                                                                      tokenSet: TokenSet
                                                                                                                                                                                                                                                                                                                      user: User

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/types.SessionDataStore.html b/docs/interfaces/types.SessionDataStore.html index 276d69386..52bb1b87d 100644 --- a/docs/interfaces/types.SessionDataStore.html +++ b/docs/interfaces/types.SessionDataStore.html @@ -1,14 +1,20 @@ -SessionDataStore | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Interface SessionDataStore

                                                                                                                                                                                                                                                                                                                        interface SessionDataStore {
                                                                                                                                                                                                                                                                                                                            delete(id: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                            deleteByLogoutToken?(logoutToken: LogoutToken): Promise<void>;
                                                                                                                                                                                                                                                                                                                            get(id: string): Promise<SessionData | null>;
                                                                                                                                                                                                                                                                                                                            set(id: string, session: SessionData): Promise<void>;
                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                        delete +SessionDataStore | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Interface SessionDataStore

                                                                                                                                                                                                                                                                                                                          Interface for a custom session data store.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          TTL contract: every successful write method (set, update) must reset the session +TTL/expiry so that active sessions are not silently expired between requests.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          interface SessionDataStore {
                                                                                                                                                                                                                                                                                                                              delete(id: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                              deleteByLogoutToken?(logoutToken: LogoutToken): Promise<void>;
                                                                                                                                                                                                                                                                                                                              get(id: string): Promise<SessionData | null>;
                                                                                                                                                                                                                                                                                                                              set(id: string, session: SessionData): Promise<void>;
                                                                                                                                                                                                                                                                                                                              update?(id: string, session: SessionData): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                          delete deleteByLogoutToken? get set +update?

                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                          • Destroys the session with the given session ID.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                            • id: string

                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                          • Deletes the session with the given logout token which may contain a session ID or a user ID, or both.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                            • id: string

                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                          • Deletes the session with the given logout token which may contain a session ID or a user ID, or both.

                                                                                                                                                                                                                                                                                                                            MCD resolver mode: When using multiple custom domains with a domain resolver, implementations MUST filter on the iss field in addition to sub/sid to ensure sessions are only deleted for the matching issuer. Custom domains on the same tenant share signing keys, so failing to filter on iss allows a logout token from one domain to delete sessions created by a different domain.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                          Returns Promise<void>

                                                                                                                                                                                                                                                                                                                          • Optional: update the session by its ID only if it already exists. +Return true if updated, false if not found.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                            Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/types.SessionStoreOptions.html b/docs/interfaces/types.SessionStoreOptions.html index 0e74caaae..c8f48ceeb 100644 --- a/docs/interfaces/types.SessionStoreOptions.html +++ b/docs/interfaces/types.SessionStoreOptions.html @@ -1,4 +1,4 @@ -SessionStoreOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Interface SessionStoreOptions

                                                                                                                                                                                                                                                                                                                            interface SessionStoreOptions {
                                                                                                                                                                                                                                                                                                                                absoluteDuration?: number;
                                                                                                                                                                                                                                                                                                                                cookie?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                                cookieOptions?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                                inactivityDuration?: number;
                                                                                                                                                                                                                                                                                                                                rolling?: boolean;
                                                                                                                                                                                                                                                                                                                                secret: string;
                                                                                                                                                                                                                                                                                                                                store?: SessionDataStore;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            absoluteDuration? +SessionStoreOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Interface SessionStoreOptions

                                                                                                                                                                                                                                                                                                                              interface SessionStoreOptions {
                                                                                                                                                                                                                                                                                                                                  absoluteDuration?: number;
                                                                                                                                                                                                                                                                                                                                  cookie?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                                  cookieOptions?: SessionCookieOptions;
                                                                                                                                                                                                                                                                                                                                  inactivityDuration?: number;
                                                                                                                                                                                                                                                                                                                                  rolling?: boolean;
                                                                                                                                                                                                                                                                                                                                  secret: string;
                                                                                                                                                                                                                                                                                                                                  store?: SessionDataStore;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              absoluteDuration? cookie? cookieOptions? inactivityDuration? @@ -8,12 +8,12 @@

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              absoluteDuration?: number

                                                                                                                                                                                                                                                                                                                              The absolute duration after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                                              Once the absolute duration has been reached, the session will no longer be extended.

                                                                                                                                                                                                                                                                                                                              Default: 3 days.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              cookie?: SessionCookieOptions

                                                                                                                                                                                                                                                                                                                              The options for the session cookie.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              cookieOptions?: SessionCookieOptions
                                                                                                                                                                                                                                                                                                                              inactivityDuration?: number

                                                                                                                                                                                                                                                                                                                              The duration of inactivity after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              cookie?: SessionCookieOptions

                                                                                                                                                                                                                                                                                                                              The options for the session cookie.

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              cookieOptions?: SessionCookieOptions
                                                                                                                                                                                                                                                                                                                              inactivityDuration?: number

                                                                                                                                                                                                                                                                                                                              The duration of inactivity after which the session will expire. The value must be specified in seconds.

                                                                                                                                                                                                                                                                                                                              The session will be extended as long as it was active before the inactivity duration has been reached.

                                                                                                                                                                                                                                                                                                                              Default: 1 day.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              rolling?: boolean

                                                                                                                                                                                                                                                                                                                              A boolean indicating whether rolling sessions should be used or not.

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              rolling?: boolean

                                                                                                                                                                                                                                                                                                                              A boolean indicating whether rolling sessions should be used or not.

                                                                                                                                                                                                                                                                                                                              When enabled, the session will continue to be extended as long as it is used within the inactivity duration. Once the upper bound, set via the absoluteDuration, has been reached, the session will no longer be extended.

                                                                                                                                                                                                                                                                                                                              Default: true.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              secret: string
                                                                                                                                                                                                                                                                                                                              store?: SessionDataStore

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              secret: string
                                                                                                                                                                                                                                                                                                                              store?: SessionDataStore

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/types.StartInteractiveLoginOptions.html b/docs/interfaces/types.StartInteractiveLoginOptions.html index 18cb874de..13b788a60 100644 --- a/docs/interfaces/types.StartInteractiveLoginOptions.html +++ b/docs/interfaces/types.StartInteractiveLoginOptions.html @@ -1,5 +1,5 @@ -StartInteractiveLoginOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Interface StartInteractiveLoginOptions

                                                                                                                                                                                                                                                                                                                                interface StartInteractiveLoginOptions {
                                                                                                                                                                                                                                                                                                                                    authorizationParameters?: AuthorizationParameters;
                                                                                                                                                                                                                                                                                                                                    returnTo?: string;
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                authorizationParameters? +StartInteractiveLoginOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Interface StartInteractiveLoginOptions

                                                                                                                                                                                                                                                                                                                                  interface StartInteractiveLoginOptions {
                                                                                                                                                                                                                                                                                                                                      authorizationParameters?: AuthorizationParameters;
                                                                                                                                                                                                                                                                                                                                      returnTo?: string;
                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  authorizationParameters? returnTo?

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  authorizationParameters?: AuthorizationParameters

                                                                                                                                                                                                                                                                                                                                  Authorization parameters to be passed to the authorization server.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  returnTo?: string

                                                                                                                                                                                                                                                                                                                                  The URL to redirect to after a successful login.

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  returnTo?: string

                                                                                                                                                                                                                                                                                                                                  The URL to redirect to after a successful login.

                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/types.TokenSet.html b/docs/interfaces/types.TokenSet.html index ac2a7dc66..5b9d5277f 100644 --- a/docs/interfaces/types.TokenSet.html +++ b/docs/interfaces/types.TokenSet.html @@ -1,4 +1,4 @@ -TokenSet | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Interface TokenSet

                                                                                                                                                                                                                                                                                                                                    interface TokenSet {
                                                                                                                                                                                                                                                                                                                                        accessToken: string;
                                                                                                                                                                                                                                                                                                                                        audience?: string;
                                                                                                                                                                                                                                                                                                                                        expiresAt: number;
                                                                                                                                                                                                                                                                                                                                        idToken?: string;
                                                                                                                                                                                                                                                                                                                                        refreshToken?: string;
                                                                                                                                                                                                                                                                                                                                        requestedScope?: string;
                                                                                                                                                                                                                                                                                                                                        scope?: string;
                                                                                                                                                                                                                                                                                                                                        token_type?: string;
                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    accessToken +TokenSet | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                      Interface TokenSet

                                                                                                                                                                                                                                                                                                                                      interface TokenSet {
                                                                                                                                                                                                                                                                                                                                          accessToken: string;
                                                                                                                                                                                                                                                                                                                                          audience?: string;
                                                                                                                                                                                                                                                                                                                                          expiresAt: number;
                                                                                                                                                                                                                                                                                                                                          idToken?: string;
                                                                                                                                                                                                                                                                                                                                          refreshToken?: string;
                                                                                                                                                                                                                                                                                                                                          requestedScope?: string;
                                                                                                                                                                                                                                                                                                                                          scope?: string;
                                                                                                                                                                                                                                                                                                                                          token_type?: string;
                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      accessToken audience? expiresAt idToken? @@ -6,4 +6,4 @@ requestedScope? scope? token_type? -

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      accessToken: string
                                                                                                                                                                                                                                                                                                                                      audience?: string
                                                                                                                                                                                                                                                                                                                                      expiresAt: number
                                                                                                                                                                                                                                                                                                                                      idToken?: string
                                                                                                                                                                                                                                                                                                                                      refreshToken?: string
                                                                                                                                                                                                                                                                                                                                      requestedScope?: string
                                                                                                                                                                                                                                                                                                                                      scope?: string
                                                                                                                                                                                                                                                                                                                                      token_type?: string

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      accessToken: string
                                                                                                                                                                                                                                                                                                                                      audience?: string
                                                                                                                                                                                                                                                                                                                                      expiresAt: number
                                                                                                                                                                                                                                                                                                                                      idToken?: string
                                                                                                                                                                                                                                                                                                                                      refreshToken?: string
                                                                                                                                                                                                                                                                                                                                      requestedScope?: string
                                                                                                                                                                                                                                                                                                                                      scope?: string
                                                                                                                                                                                                                                                                                                                                      token_type?: string

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/types.TransactionCookieOptions.html b/docs/interfaces/types.TransactionCookieOptions.html index 9c01d1bf0..05081c055 100644 --- a/docs/interfaces/types.TransactionCookieOptions.html +++ b/docs/interfaces/types.TransactionCookieOptions.html @@ -1,4 +1,4 @@ -TransactionCookieOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                        Interface TransactionCookieOptions

                                                                                                                                                                                                                                                                                                                                        interface TransactionCookieOptions {
                                                                                                                                                                                                                                                                                                                                            domain?: string;
                                                                                                                                                                                                                                                                                                                                            maxAge?: number;
                                                                                                                                                                                                                                                                                                                                            path?: string;
                                                                                                                                                                                                                                                                                                                                            prefix?: string;
                                                                                                                                                                                                                                                                                                                                            sameSite?: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                                                                                            secure?: boolean;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        domain? +TransactionCookieOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                          Interface TransactionCookieOptions

                                                                                                                                                                                                                                                                                                                                          interface TransactionCookieOptions {
                                                                                                                                                                                                                                                                                                                                              domain?: string;
                                                                                                                                                                                                                                                                                                                                              maxAge?: number;
                                                                                                                                                                                                                                                                                                                                              path?: string;
                                                                                                                                                                                                                                                                                                                                              prefix?: string;
                                                                                                                                                                                                                                                                                                                                              sameSite?: "lax" | "strict" | "none";
                                                                                                                                                                                                                                                                                                                                              secure?: boolean;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          domain? maxAge? path? prefix? @@ -7,16 +7,16 @@

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          domain?: string

                                                                                                                                                                                                                                                                                                                                          Specifies the value for the Set-Cookie attribute. By default, no domain is set, and most clients will consider the cookie to apply to only the current domain.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          maxAge?: number

                                                                                                                                                                                                                                                                                                                                          The expiration time for transaction cookies in seconds. +

                                                                                                                                                                                                                                                                                                                                          maxAge?: number

                                                                                                                                                                                                                                                                                                                                          The expiration time for transaction cookies in seconds. If not provided, defaults to 1 hour (3600 seconds).

                                                                                                                                                                                                                                                                                                                                          3600
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          path?: string

                                                                                                                                                                                                                                                                                                                                          The path attribute of the transaction cookie. Will be set to '/' by default.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          prefix?: string

                                                                                                                                                                                                                                                                                                                                          The prefix of the cookie used to store the transaction state.

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          path?: string

                                                                                                                                                                                                                                                                                                                                          The path attribute of the transaction cookie. Will be set to '/' by default.

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          prefix?: string

                                                                                                                                                                                                                                                                                                                                          The prefix of the cookie used to store the transaction state.

                                                                                                                                                                                                                                                                                                                                          Default: __txn_{state}.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          sameSite?: "lax" | "strict" | "none"

                                                                                                                                                                                                                                                                                                                                          The sameSite attribute of the transaction cookie.

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          sameSite?: "lax" | "strict" | "none"

                                                                                                                                                                                                                                                                                                                                          The sameSite attribute of the transaction cookie.

                                                                                                                                                                                                                                                                                                                                          Default: lax.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          secure?: boolean

                                                                                                                                                                                                                                                                                                                                          The secure attribute of the transaction cookie.

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          secure?: boolean

                                                                                                                                                                                                                                                                                                                                          The secure attribute of the transaction cookie.

                                                                                                                                                                                                                                                                                                                                          Default: depends on the protocol of the application's base URL. If the protocol is https, then true, otherwise false.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/types.TransactionState.html b/docs/interfaces/types.TransactionState.html index 0c9084dcc..c8ba529c2 100644 --- a/docs/interfaces/types.TransactionState.html +++ b/docs/interfaces/types.TransactionState.html @@ -1,5 +1,5 @@ -TransactionState | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                            Interface TransactionState

                                                                                                                                                                                                                                                                                                                                            interface TransactionState {
                                                                                                                                                                                                                                                                                                                                                audience?: string;
                                                                                                                                                                                                                                                                                                                                                authSession?: string;
                                                                                                                                                                                                                                                                                                                                                codeVerifier: string;
                                                                                                                                                                                                                                                                                                                                                maxAge?: number;
                                                                                                                                                                                                                                                                                                                                                nonce?: string;
                                                                                                                                                                                                                                                                                                                                                originDomain?: string;
                                                                                                                                                                                                                                                                                                                                                originIssuer?: string;
                                                                                                                                                                                                                                                                                                                                                responseType: RESPONSE_TYPES;
                                                                                                                                                                                                                                                                                                                                                returnTo: string;
                                                                                                                                                                                                                                                                                                                                                scope?: string;
                                                                                                                                                                                                                                                                                                                                                state: string;
                                                                                                                                                                                                                                                                                                                                                [propName: string]: unknown;
                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                            • JWTPayload
                                                                                                                                                                                                                                                                                                                                              • TransactionState

                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                            • [propName: string]: unknown

                                                                                                                                                                                                                                                                                                                                              Any other JWT Claim Set member.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            audience? +TransactionState | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Interface TransactionState

                                                                                                                                                                                                                                                                                                                                              interface TransactionState {
                                                                                                                                                                                                                                                                                                                                                  audience?: string;
                                                                                                                                                                                                                                                                                                                                                  authSession?: string;
                                                                                                                                                                                                                                                                                                                                                  codeVerifier: string;
                                                                                                                                                                                                                                                                                                                                                  maxAge?: number;
                                                                                                                                                                                                                                                                                                                                                  nonce?: string;
                                                                                                                                                                                                                                                                                                                                                  originDomain?: string;
                                                                                                                                                                                                                                                                                                                                                  originIssuer?: string;
                                                                                                                                                                                                                                                                                                                                                  responseType: RESPONSE_TYPES;
                                                                                                                                                                                                                                                                                                                                                  returnTo: string;
                                                                                                                                                                                                                                                                                                                                                  scope?: string;
                                                                                                                                                                                                                                                                                                                                                  state: string;
                                                                                                                                                                                                                                                                                                                                                  [propName: string]: unknown;
                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                              • JWTPayload
                                                                                                                                                                                                                                                                                                                                                • TransactionState

                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                              • [propName: string]: unknown

                                                                                                                                                                                                                                                                                                                                                Any other JWT Claim Set member.

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              audience? authSession? codeVerifier maxAge? @@ -11,9 +11,9 @@ scope? state

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              audience?: string

                                                                                                                                                                                                                                                                                                                                              The audience used for this transaction.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              authSession?: string
                                                                                                                                                                                                                                                                                                                                              codeVerifier: string
                                                                                                                                                                                                                                                                                                                                              maxAge?: number
                                                                                                                                                                                                                                                                                                                                              nonce?: string
                                                                                                                                                                                                                                                                                                                                              originDomain?: string

                                                                                                                                                                                                                                                                                                                                              The Auth0 domain used for this transaction (MCD mode). +

                                                                                                                                                                                                                                                                                                                                              authSession?: string
                                                                                                                                                                                                                                                                                                                                              codeVerifier: string
                                                                                                                                                                                                                                                                                                                                              maxAge?: number
                                                                                                                                                                                                                                                                                                                                              nonce?: string
                                                                                                                                                                                                                                                                                                                                              originDomain?: string

                                                                                                                                                                                                                                                                                                                                              The Auth0 domain used for this transaction (MCD mode). Stored to validate that the session is for the same domain.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              originIssuer?: string

                                                                                                                                                                                                                                                                                                                                              The OIDC issuer URL for this transaction (MCD mode). +

                                                                                                                                                                                                                                                                                                                                              originIssuer?: string

                                                                                                                                                                                                                                                                                                                                              The OIDC issuer URL for this transaction (MCD mode). Stored alongside originDomain for validation.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              responseType: RESPONSE_TYPES
                                                                                                                                                                                                                                                                                                                                              returnTo: string
                                                                                                                                                                                                                                                                                                                                              scope?: string

                                                                                                                                                                                                                                                                                                                                              The scope requested for this transaction.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              state: string

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              responseType: RESPONSE_TYPES
                                                                                                                                                                                                                                                                                                                                              returnTo: string
                                                                                                                                                                                                                                                                                                                                              scope?: string

                                                                                                                                                                                                                                                                                                                                              The scope requested for this transaction.

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              state: string

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/types.TransactionStoreOptions.html b/docs/interfaces/types.TransactionStoreOptions.html index 594c5dced..4ca9b37b4 100644 --- a/docs/interfaces/types.TransactionStoreOptions.html +++ b/docs/interfaces/types.TransactionStoreOptions.html @@ -1,10 +1,10 @@ -TransactionStoreOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Interface TransactionStoreOptions

                                                                                                                                                                                                                                                                                                                                                interface TransactionStoreOptions {
                                                                                                                                                                                                                                                                                                                                                    cookieOptions?: TransactionCookieOptions;
                                                                                                                                                                                                                                                                                                                                                    enableParallelTransactions?: boolean;
                                                                                                                                                                                                                                                                                                                                                    secret: string;
                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                cookieOptions? +TransactionStoreOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Interface TransactionStoreOptions

                                                                                                                                                                                                                                                                                                                                                  interface TransactionStoreOptions {
                                                                                                                                                                                                                                                                                                                                                      cookieOptions?: TransactionCookieOptions;
                                                                                                                                                                                                                                                                                                                                                      enableParallelTransactions?: boolean;
                                                                                                                                                                                                                                                                                                                                                      secret: string;
                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  cookieOptions? enableParallelTransactions? secret -

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  cookieOptions?: TransactionCookieOptions
                                                                                                                                                                                                                                                                                                                                                  enableParallelTransactions?: boolean

                                                                                                                                                                                                                                                                                                                                                  Controls whether multiple parallel login transactions are allowed. +

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  cookieOptions?: TransactionCookieOptions
                                                                                                                                                                                                                                                                                                                                                  enableParallelTransactions?: boolean

                                                                                                                                                                                                                                                                                                                                                  Controls whether multiple parallel login transactions are allowed. When false, only one transaction cookie is maintained at a time. When true (default), multiple transaction cookies can coexist for multi-tab support.

                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  secret: string

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  secret: string

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/types.User.html b/docs/interfaces/types.User.html index 9c2c2f4ec..d1aef0636 100644 --- a/docs/interfaces/types.User.html +++ b/docs/interfaces/types.User.html @@ -1,4 +1,4 @@ -User | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Interface User

                                                                                                                                                                                                                                                                                                                                                    interface User {
                                                                                                                                                                                                                                                                                                                                                        email?: string;
                                                                                                                                                                                                                                                                                                                                                        email_verified?: boolean;
                                                                                                                                                                                                                                                                                                                                                        family_name?: string;
                                                                                                                                                                                                                                                                                                                                                        given_name?: string;
                                                                                                                                                                                                                                                                                                                                                        name?: string;
                                                                                                                                                                                                                                                                                                                                                        nickname?: string;
                                                                                                                                                                                                                                                                                                                                                        org_id?: string;
                                                                                                                                                                                                                                                                                                                                                        picture?: string;
                                                                                                                                                                                                                                                                                                                                                        sub: string;
                                                                                                                                                                                                                                                                                                                                                        [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                    • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    email? +User | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Interface User

                                                                                                                                                                                                                                                                                                                                                      interface User {
                                                                                                                                                                                                                                                                                                                                                          email?: string;
                                                                                                                                                                                                                                                                                                                                                          email_verified?: boolean;
                                                                                                                                                                                                                                                                                                                                                          family_name?: string;
                                                                                                                                                                                                                                                                                                                                                          given_name?: string;
                                                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                                                          nickname?: string;
                                                                                                                                                                                                                                                                                                                                                          org_id?: string;
                                                                                                                                                                                                                                                                                                                                                          picture?: string;
                                                                                                                                                                                                                                                                                                                                                          sub: string;
                                                                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                      • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      email? email_verified? family_name? given_name? @@ -7,6 +7,6 @@ org_id? picture? sub -

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      email?: string
                                                                                                                                                                                                                                                                                                                                                      email_verified?: boolean
                                                                                                                                                                                                                                                                                                                                                      family_name?: string
                                                                                                                                                                                                                                                                                                                                                      given_name?: string
                                                                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                                                                      nickname?: string
                                                                                                                                                                                                                                                                                                                                                      org_id?: string

                                                                                                                                                                                                                                                                                                                                                      The organization ID that the user belongs to. +

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      email?: string
                                                                                                                                                                                                                                                                                                                                                      email_verified?: boolean
                                                                                                                                                                                                                                                                                                                                                      family_name?: string
                                                                                                                                                                                                                                                                                                                                                      given_name?: string
                                                                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                                                                      nickname?: string
                                                                                                                                                                                                                                                                                                                                                      org_id?: string

                                                                                                                                                                                                                                                                                                                                                      The organization ID that the user belongs to. This field is populated when the user logs in through an organization.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      picture?: string
                                                                                                                                                                                                                                                                                                                                                      sub: string

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      picture?: string
                                                                                                                                                                                                                                                                                                                                                      sub: string

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/types.VerifyMfaOptionsBase.html b/docs/interfaces/types.VerifyMfaOptionsBase.html index 411749a22..7ddaf2cef 100644 --- a/docs/interfaces/types.VerifyMfaOptionsBase.html +++ b/docs/interfaces/types.VerifyMfaOptionsBase.html @@ -1,4 +1,4 @@ -VerifyMfaOptionsBase | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Interface VerifyMfaOptionsBase

                                                                                                                                                                                                                                                                                                                                                        Base options for MFA verify.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        interface VerifyMfaOptionsBase {
                                                                                                                                                                                                                                                                                                                                                            mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        mfaToken +VerifyMfaOptionsBase | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Interface VerifyMfaOptionsBase

                                                                                                                                                                                                                                                                                                                                                          Base options for MFA verify.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          interface VerifyMfaOptionsBase {
                                                                                                                                                                                                                                                                                                                                                              mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          mfaToken

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          mfaToken: string

                                                                                                                                                                                                                                                                                                                                                          Encrypted MFA token

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/types.VerifyMfaWithOobOptions.html b/docs/interfaces/types.VerifyMfaWithOobOptions.html index 3ec56af9d..b842b3983 100644 --- a/docs/interfaces/types.VerifyMfaWithOobOptions.html +++ b/docs/interfaces/types.VerifyMfaWithOobOptions.html @@ -1,9 +1,9 @@ -VerifyMfaWithOobOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Interface VerifyMfaWithOobOptions

                                                                                                                                                                                                                                                                                                                                                            Verification with OOB code sent via SMS/Email/Push.

                                                                                                                                                                                                                                                                                                                                                            +VerifyMfaWithOobOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Interface VerifyMfaWithOobOptions

                                                                                                                                                                                                                                                                                                                                                              Verification with OOB code sent via SMS/Email/Push.

                                                                                                                                                                                                                                                                                                                                                              // After calling challenge()
                                                                                                                                                                                                                                                                                                                                                              const challengeResponse = await mfa.challenge({
                                                                                                                                                                                                                                                                                                                                                                mfaToken,
                                                                                                                                                                                                                                                                                                                                                                challengeType: 'oob',
                                                                                                                                                                                                                                                                                                                                                                authenticatorId: 'sms|dev_abc123'
                                                                                                                                                                                                                                                                                                                                                              });

                                                                                                                                                                                                                                                                                                                                                              // User receives code "543210"
                                                                                                                                                                                                                                                                                                                                                              await mfa.verify({
                                                                                                                                                                                                                                                                                                                                                                mfaToken,
                                                                                                                                                                                                                                                                                                                                                                oobCode: challengeResponse.oobCode,
                                                                                                                                                                                                                                                                                                                                                                bindingCode: '543210'
                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              interface VerifyMfaWithOobOptions {
                                                                                                                                                                                                                                                                                                                                                                  bindingCode: string;
                                                                                                                                                                                                                                                                                                                                                                  mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                  oobCode: string;
                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              bindingCode +
                                                                                                                                                                                                                                                                                                                                                              interface VerifyMfaWithOobOptions {
                                                                                                                                                                                                                                                                                                                                                                  bindingCode: string;
                                                                                                                                                                                                                                                                                                                                                                  mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                  oobCode: string;
                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              bindingCode mfaToken oobCode -

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              bindingCode: string
                                                                                                                                                                                                                                                                                                                                                              mfaToken: string

                                                                                                                                                                                                                                                                                                                                                              Encrypted MFA token

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              oobCode: string

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              bindingCode: string
                                                                                                                                                                                                                                                                                                                                                              mfaToken: string

                                                                                                                                                                                                                                                                                                                                                              Encrypted MFA token

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              oobCode: string

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/types.VerifyMfaWithOtpOptions.html b/docs/interfaces/types.VerifyMfaWithOtpOptions.html index 0d8151108..b4d25785d 100644 --- a/docs/interfaces/types.VerifyMfaWithOtpOptions.html +++ b/docs/interfaces/types.VerifyMfaWithOtpOptions.html @@ -1,8 +1,8 @@ -VerifyMfaWithOtpOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                Interface VerifyMfaWithOtpOptions

                                                                                                                                                                                                                                                                                                                                                                Verification with OTP code from authenticator app.

                                                                                                                                                                                                                                                                                                                                                                +VerifyMfaWithOtpOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                  Interface VerifyMfaWithOtpOptions

                                                                                                                                                                                                                                                                                                                                                                  Verification with OTP code from authenticator app.

                                                                                                                                                                                                                                                                                                                                                                  import { mfa } from '@auth0/nextjs-auth0/client';

                                                                                                                                                                                                                                                                                                                                                                  try {
                                                                                                                                                                                                                                                                                                                                                                    await mfa.verify({
                                                                                                                                                                                                                                                                                                                                                                      mfaToken: encryptedToken,
                                                                                                                                                                                                                                                                                                                                                                      otp: '123456' // From Google Authenticator
                                                                                                                                                                                                                                                                                                                                                                    });
                                                                                                                                                                                                                                                                                                                                                                    // User authenticated, access token in session
                                                                                                                                                                                                                                                                                                                                                                  } catch (error) {
                                                                                                                                                                                                                                                                                                                                                                    if (error instanceof MfaVerifyError) {
                                                                                                                                                                                                                                                                                                                                                                      console.error('Invalid OTP code');
                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  interface VerifyMfaWithOtpOptions {
                                                                                                                                                                                                                                                                                                                                                                      mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                      otp: string;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  mfaToken +
                                                                                                                                                                                                                                                                                                                                                                  interface VerifyMfaWithOtpOptions {
                                                                                                                                                                                                                                                                                                                                                                      mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                      otp: string;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  mfaToken otp

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  mfaToken: string

                                                                                                                                                                                                                                                                                                                                                                  Encrypted MFA token

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  otp: string

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  otp: string

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/types.VerifyMfaWithRecoveryCodeOptions.html b/docs/interfaces/types.VerifyMfaWithRecoveryCodeOptions.html index 969fc725c..053f97305 100644 --- a/docs/interfaces/types.VerifyMfaWithRecoveryCodeOptions.html +++ b/docs/interfaces/types.VerifyMfaWithRecoveryCodeOptions.html @@ -1,8 +1,8 @@ -VerifyMfaWithRecoveryCodeOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                    Interface VerifyMfaWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                                                    Verification with recovery code (backup).

                                                                                                                                                                                                                                                                                                                                                                    +VerifyMfaWithRecoveryCodeOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                      Interface VerifyMfaWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                                                      Verification with recovery code (backup).

                                                                                                                                                                                                                                                                                                                                                                      // Using recovery code from enrollment
                                                                                                                                                                                                                                                                                                                                                                      await mfa.verify({
                                                                                                                                                                                                                                                                                                                                                                        mfaToken,
                                                                                                                                                                                                                                                                                                                                                                        recoveryCode: 'ABCD-EFGH-IJKL-MNOP'
                                                                                                                                                                                                                                                                                                                                                                      });
                                                                                                                                                                                                                                                                                                                                                                      // Recovery code is single-use and invalidated after verification
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      interface VerifyMfaWithRecoveryCodeOptions {
                                                                                                                                                                                                                                                                                                                                                                          mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                          recoveryCode: string;
                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      mfaToken +
                                                                                                                                                                                                                                                                                                                                                                      interface VerifyMfaWithRecoveryCodeOptions {
                                                                                                                                                                                                                                                                                                                                                                          mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                          recoveryCode: string;
                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      mfaToken recoveryCode

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      mfaToken: string

                                                                                                                                                                                                                                                                                                                                                                      Encrypted MFA token

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      recoveryCode: string

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      recoveryCode: string

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/modules.html b/docs/modules.html index 483595d76..56cdd0bb4 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -@auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1

                                                                                                                                                                                                                                                                                                                                                                          Modules

                                                                                                                                                                                                                                                                                                                                                                          client
                                                                                                                                                                                                                                                                                                                                                                          errors
                                                                                                                                                                                                                                                                                                                                                                          server
                                                                                                                                                                                                                                                                                                                                                                          testing
                                                                                                                                                                                                                                                                                                                                                                          types

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                          Modules
                                                                                                                                                                                                                                                                                                                                                                          +@auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                              Modules

                                                                                                                                                                                                                                                                                                                                                                              client
                                                                                                                                                                                                                                                                                                                                                                              errors
                                                                                                                                                                                                                                                                                                                                                                              server
                                                                                                                                                                                                                                                                                                                                                                              testing
                                                                                                                                                                                                                                                                                                                                                                              types

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                              Modules
                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/modules/client.html b/docs/modules/client.html index 4f8ed5125..a80f9125c 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -1 +1 @@ -client | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                Module client

                                                                                                                                                                                                                                                                                                                                                                                Interfaces

                                                                                                                                                                                                                                                                                                                                                                                WithPageAuthRequiredOptions

                                                                                                                                                                                                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                WithPageAuthRequired

                                                                                                                                                                                                                                                                                                                                                                                Variables

                                                                                                                                                                                                                                                                                                                                                                                mfa
                                                                                                                                                                                                                                                                                                                                                                                withPageAuthRequired

                                                                                                                                                                                                                                                                                                                                                                                Functions

                                                                                                                                                                                                                                                                                                                                                                                Auth0Provider
                                                                                                                                                                                                                                                                                                                                                                                getAccessToken
                                                                                                                                                                                                                                                                                                                                                                                useUser

                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                Interfaces
                                                                                                                                                                                                                                                                                                                                                                                Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                Variables
                                                                                                                                                                                                                                                                                                                                                                                Functions
                                                                                                                                                                                                                                                                                                                                                                                +client | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                  Module client

                                                                                                                                                                                                                                                                                                                                                                                  Interfaces

                                                                                                                                                                                                                                                                                                                                                                                  WithPageAuthRequiredOptions

                                                                                                                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                  WithPageAuthRequired

                                                                                                                                                                                                                                                                                                                                                                                  Variables

                                                                                                                                                                                                                                                                                                                                                                                  mfa
                                                                                                                                                                                                                                                                                                                                                                                  withPageAuthRequired

                                                                                                                                                                                                                                                                                                                                                                                  Functions

                                                                                                                                                                                                                                                                                                                                                                                  Auth0Provider
                                                                                                                                                                                                                                                                                                                                                                                  getAccessToken
                                                                                                                                                                                                                                                                                                                                                                                  useUser

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                  Interfaces
                                                                                                                                                                                                                                                                                                                                                                                  Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                  Variables
                                                                                                                                                                                                                                                                                                                                                                                  Functions
                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/modules/errors.html b/docs/modules/errors.html index bac9c846e..22029a383 100644 --- a/docs/modules/errors.html +++ b/docs/modules/errors.html @@ -1 +1 @@ -errors | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                    Module errors

                                                                                                                                                                                                                                                                                                                                                                                    Enumerations

                                                                                                                                                                                                                                                                                                                                                                                    AccessTokenErrorCode
                                                                                                                                                                                                                                                                                                                                                                                    AccessTokenForConnectionErrorCode
                                                                                                                                                                                                                                                                                                                                                                                    ConnectAccountErrorCodes
                                                                                                                                                                                                                                                                                                                                                                                    CustomTokenExchangeErrorCode
                                                                                                                                                                                                                                                                                                                                                                                    DPoPErrorCode

                                                                                                                                                                                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                                                                                                                                                                                    AccessTokenError
                                                                                                                                                                                                                                                                                                                                                                                    AccessTokenForConnectionError
                                                                                                                                                                                                                                                                                                                                                                                    AuthorizationCodeGrantError
                                                                                                                                                                                                                                                                                                                                                                                    AuthorizationCodeGrantRequestError
                                                                                                                                                                                                                                                                                                                                                                                    AuthorizationError
                                                                                                                                                                                                                                                                                                                                                                                    BackchannelAuthenticationError
                                                                                                                                                                                                                                                                                                                                                                                    BackchannelAuthenticationNotSupportedError
                                                                                                                                                                                                                                                                                                                                                                                    BackchannelLogoutError
                                                                                                                                                                                                                                                                                                                                                                                    ConnectAccountError
                                                                                                                                                                                                                                                                                                                                                                                    CustomTokenExchangeError
                                                                                                                                                                                                                                                                                                                                                                                    DiscoveryError
                                                                                                                                                                                                                                                                                                                                                                                    DPoPError
                                                                                                                                                                                                                                                                                                                                                                                    InvalidConfigurationError
                                                                                                                                                                                                                                                                                                                                                                                    InvalidRequestError
                                                                                                                                                                                                                                                                                                                                                                                    InvalidStateError
                                                                                                                                                                                                                                                                                                                                                                                    MfaChallengeError
                                                                                                                                                                                                                                                                                                                                                                                    MfaEnrollmentError
                                                                                                                                                                                                                                                                                                                                                                                    MfaGetAuthenticatorsError
                                                                                                                                                                                                                                                                                                                                                                                    MfaNoAvailableFactorsError
                                                                                                                                                                                                                                                                                                                                                                                    MfaVerifyError
                                                                                                                                                                                                                                                                                                                                                                                    MissingStateError
                                                                                                                                                                                                                                                                                                                                                                                    MyAccountApiError
                                                                                                                                                                                                                                                                                                                                                                                    OAuth2Error
                                                                                                                                                                                                                                                                                                                                                                                    SdkError

                                                                                                                                                                                                                                                                                                                                                                                    Interfaces

                                                                                                                                                                                                                                                                                                                                                                                    MfaApiErrorResponse

                                                                                                                                                                                                                                                                                                                                                                                    References

                                                                                                                                                                                                                                                                                                                                                                                    DomainResolutionError → DomainResolutionError
                                                                                                                                                                                                                                                                                                                                                                                    DomainValidationError → DomainValidationError
                                                                                                                                                                                                                                                                                                                                                                                    IssuerValidationError → IssuerValidationError
                                                                                                                                                                                                                                                                                                                                                                                    MfaRequiredError → MfaRequiredError
                                                                                                                                                                                                                                                                                                                                                                                    MfaRequirements → MfaRequirements
                                                                                                                                                                                                                                                                                                                                                                                    MfaTokenExpiredError → MfaTokenExpiredError
                                                                                                                                                                                                                                                                                                                                                                                    MfaTokenInvalidError → MfaTokenInvalidError
                                                                                                                                                                                                                                                                                                                                                                                    SessionDomainMismatchError → SessionDomainMismatchError

                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                    Enumerations
                                                                                                                                                                                                                                                                                                                                                                                    Classes
                                                                                                                                                                                                                                                                                                                                                                                    Interfaces
                                                                                                                                                                                                                                                                                                                                                                                    References
                                                                                                                                                                                                                                                                                                                                                                                    +errors | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                      Module errors

                                                                                                                                                                                                                                                                                                                                                                                      Enumerations

                                                                                                                                                                                                                                                                                                                                                                                      AccessTokenErrorCode
                                                                                                                                                                                                                                                                                                                                                                                      AccessTokenForConnectionErrorCode
                                                                                                                                                                                                                                                                                                                                                                                      ConnectAccountErrorCodes
                                                                                                                                                                                                                                                                                                                                                                                      CustomTokenExchangeErrorCode
                                                                                                                                                                                                                                                                                                                                                                                      DPoPErrorCode

                                                                                                                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                                                                                                                      AccessTokenError
                                                                                                                                                                                                                                                                                                                                                                                      AccessTokenForConnectionError
                                                                                                                                                                                                                                                                                                                                                                                      AuthorizationCodeGrantError
                                                                                                                                                                                                                                                                                                                                                                                      AuthorizationCodeGrantRequestError
                                                                                                                                                                                                                                                                                                                                                                                      AuthorizationError
                                                                                                                                                                                                                                                                                                                                                                                      BackchannelAuthenticationError
                                                                                                                                                                                                                                                                                                                                                                                      BackchannelAuthenticationNotSupportedError
                                                                                                                                                                                                                                                                                                                                                                                      BackchannelLogoutError
                                                                                                                                                                                                                                                                                                                                                                                      ConnectAccountError
                                                                                                                                                                                                                                                                                                                                                                                      CustomTokenExchangeError
                                                                                                                                                                                                                                                                                                                                                                                      DiscoveryError
                                                                                                                                                                                                                                                                                                                                                                                      DPoPError
                                                                                                                                                                                                                                                                                                                                                                                      InvalidConfigurationError
                                                                                                                                                                                                                                                                                                                                                                                      InvalidRequestError
                                                                                                                                                                                                                                                                                                                                                                                      InvalidStateError
                                                                                                                                                                                                                                                                                                                                                                                      MfaChallengeError
                                                                                                                                                                                                                                                                                                                                                                                      MfaEnrollmentError
                                                                                                                                                                                                                                                                                                                                                                                      MfaGetAuthenticatorsError
                                                                                                                                                                                                                                                                                                                                                                                      MfaNoAvailableFactorsError
                                                                                                                                                                                                                                                                                                                                                                                      MfaVerifyError
                                                                                                                                                                                                                                                                                                                                                                                      MissingStateError
                                                                                                                                                                                                                                                                                                                                                                                      MyAccountApiError
                                                                                                                                                                                                                                                                                                                                                                                      OAuth2Error
                                                                                                                                                                                                                                                                                                                                                                                      SdkError

                                                                                                                                                                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                                                                                                                                                                      MfaApiErrorResponse

                                                                                                                                                                                                                                                                                                                                                                                      References

                                                                                                                                                                                                                                                                                                                                                                                      DomainResolutionError → DomainResolutionError
                                                                                                                                                                                                                                                                                                                                                                                      DomainValidationError → DomainValidationError
                                                                                                                                                                                                                                                                                                                                                                                      IssuerValidationError → IssuerValidationError
                                                                                                                                                                                                                                                                                                                                                                                      MfaRequiredError → MfaRequiredError
                                                                                                                                                                                                                                                                                                                                                                                      MfaRequirements → MfaRequirements
                                                                                                                                                                                                                                                                                                                                                                                      MfaTokenExpiredError → MfaTokenExpiredError
                                                                                                                                                                                                                                                                                                                                                                                      MfaTokenInvalidError → MfaTokenInvalidError
                                                                                                                                                                                                                                                                                                                                                                                      SessionDomainMismatchError → SessionDomainMismatchError

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                      Enumerations
                                                                                                                                                                                                                                                                                                                                                                                      Classes
                                                                                                                                                                                                                                                                                                                                                                                      Interfaces
                                                                                                                                                                                                                                                                                                                                                                                      References
                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/modules/server.html b/docs/modules/server.html index d089f0d19..907f8897a 100644 --- a/docs/modules/server.html +++ b/docs/modules/server.html @@ -1 +1 @@ -server | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                        Module server

                                                                                                                                                                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                                                                                                                                                                        AbstractSessionStore
                                                                                                                                                                                                                                                                                                                                                                                        Auth0Client
                                                                                                                                                                                                                                                                                                                                                                                        DomainResolutionError
                                                                                                                                                                                                                                                                                                                                                                                        DomainValidationError
                                                                                                                                                                                                                                                                                                                                                                                        IssuerValidationError
                                                                                                                                                                                                                                                                                                                                                                                        MfaRequiredError
                                                                                                                                                                                                                                                                                                                                                                                        MfaTokenExpiredError
                                                                                                                                                                                                                                                                                                                                                                                        MfaTokenInvalidError
                                                                                                                                                                                                                                                                                                                                                                                        SessionDomainMismatchError
                                                                                                                                                                                                                                                                                                                                                                                        TransactionStore

                                                                                                                                                                                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                                                                                                                                                                                        MfaRequirements

                                                                                                                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                        AppRouterPageRoute
                                                                                                                                                                                                                                                                                                                                                                                        AppRouterPageRouteOpts
                                                                                                                                                                                                                                                                                                                                                                                        GetServerSidePropsResultWithSession
                                                                                                                                                                                                                                                                                                                                                                                        PageRoute
                                                                                                                                                                                                                                                                                                                                                                                        WithPageAuthRequired
                                                                                                                                                                                                                                                                                                                                                                                        WithPageAuthRequiredAppRouter
                                                                                                                                                                                                                                                                                                                                                                                        WithPageAuthRequiredAppRouterOptions
                                                                                                                                                                                                                                                                                                                                                                                        WithPageAuthRequiredPageRouter
                                                                                                                                                                                                                                                                                                                                                                                        WithPageAuthRequiredPageRouterOptions

                                                                                                                                                                                                                                                                                                                                                                                        Variables

                                                                                                                                                                                                                                                                                                                                                                                        DEFAULT_ID_TOKEN_CLAIMS

                                                                                                                                                                                                                                                                                                                                                                                        Functions

                                                                                                                                                                                                                                                                                                                                                                                        filterDefaultIdTokenClaims
                                                                                                                                                                                                                                                                                                                                                                                        generateDpopKeyPair

                                                                                                                                                                                                                                                                                                                                                                                        References

                                                                                                                                                                                                                                                                                                                                                                                        DiscoveryCacheOptions → DiscoveryCacheOptions
                                                                                                                                                                                                                                                                                                                                                                                        DomainResolver → DomainResolver
                                                                                                                                                                                                                                                                                                                                                                                        MCDMetadata → MCDMetadata

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                        Classes
                                                                                                                                                                                                                                                                                                                                                                                        Interfaces
                                                                                                                                                                                                                                                                                                                                                                                        Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                        Variables
                                                                                                                                                                                                                                                                                                                                                                                        Functions
                                                                                                                                                                                                                                                                                                                                                                                        References
                                                                                                                                                                                                                                                                                                                                                                                        +server | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                          Module server

                                                                                                                                                                                                                                                                                                                                                                                          Classes

                                                                                                                                                                                                                                                                                                                                                                                          AbstractSessionStore
                                                                                                                                                                                                                                                                                                                                                                                          Auth0Client
                                                                                                                                                                                                                                                                                                                                                                                          DomainResolutionError
                                                                                                                                                                                                                                                                                                                                                                                          DomainValidationError
                                                                                                                                                                                                                                                                                                                                                                                          IssuerValidationError
                                                                                                                                                                                                                                                                                                                                                                                          MfaRequiredError
                                                                                                                                                                                                                                                                                                                                                                                          MfaTokenExpiredError
                                                                                                                                                                                                                                                                                                                                                                                          MfaTokenInvalidError
                                                                                                                                                                                                                                                                                                                                                                                          SessionDomainMismatchError
                                                                                                                                                                                                                                                                                                                                                                                          TransactionStore

                                                                                                                                                                                                                                                                                                                                                                                          Interfaces

                                                                                                                                                                                                                                                                                                                                                                                          MfaRequirements

                                                                                                                                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                          AppRouterPageRoute
                                                                                                                                                                                                                                                                                                                                                                                          AppRouterPageRouteOpts
                                                                                                                                                                                                                                                                                                                                                                                          GetServerSidePropsResultWithSession
                                                                                                                                                                                                                                                                                                                                                                                          PageRoute
                                                                                                                                                                                                                                                                                                                                                                                          WithPageAuthRequired
                                                                                                                                                                                                                                                                                                                                                                                          WithPageAuthRequiredAppRouter
                                                                                                                                                                                                                                                                                                                                                                                          WithPageAuthRequiredAppRouterOptions
                                                                                                                                                                                                                                                                                                                                                                                          WithPageAuthRequiredPageRouter
                                                                                                                                                                                                                                                                                                                                                                                          WithPageAuthRequiredPageRouterOptions

                                                                                                                                                                                                                                                                                                                                                                                          Variables

                                                                                                                                                                                                                                                                                                                                                                                          DEFAULT_ID_TOKEN_CLAIMS

                                                                                                                                                                                                                                                                                                                                                                                          Functions

                                                                                                                                                                                                                                                                                                                                                                                          filterDefaultIdTokenClaims
                                                                                                                                                                                                                                                                                                                                                                                          generateDpopKeyPair

                                                                                                                                                                                                                                                                                                                                                                                          References

                                                                                                                                                                                                                                                                                                                                                                                          DiscoveryCacheOptions → DiscoveryCacheOptions
                                                                                                                                                                                                                                                                                                                                                                                          DomainResolver → DomainResolver
                                                                                                                                                                                                                                                                                                                                                                                          MCDMetadata → MCDMetadata

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                          Classes
                                                                                                                                                                                                                                                                                                                                                                                          Interfaces
                                                                                                                                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                          Variables
                                                                                                                                                                                                                                                                                                                                                                                          Functions
                                                                                                                                                                                                                                                                                                                                                                                          References
                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/modules/testing.html b/docs/modules/testing.html index e11084f54..29be8dfe8 100644 --- a/docs/modules/testing.html +++ b/docs/modules/testing.html @@ -1 +1 @@ -testing | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                            Module testing

                                                                                                                                                                                                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                            GenerateSessionCookieConfig

                                                                                                                                                                                                                                                                                                                                                                                            Functions

                                                                                                                                                                                                                                                                                                                                                                                            generateSessionCookie

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                            Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                            Functions
                                                                                                                                                                                                                                                                                                                                                                                            +testing | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                              Module testing

                                                                                                                                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                              GenerateSessionCookieConfig

                                                                                                                                                                                                                                                                                                                                                                                              Functions

                                                                                                                                                                                                                                                                                                                                                                                              generateSessionCookie

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                              Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                              Functions
                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/modules/types.html b/docs/modules/types.html index 9e4f469de..1dc0f05f1 100644 --- a/docs/modules/types.html +++ b/docs/modules/types.html @@ -1 +1 @@ -types | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                Module types

                                                                                                                                                                                                                                                                                                                                                                                                Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                RESPONSE_TYPES
                                                                                                                                                                                                                                                                                                                                                                                                SUBJECT_TOKEN_TYPES

                                                                                                                                                                                                                                                                                                                                                                                                Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                AccessTokenForConnectionOptions
                                                                                                                                                                                                                                                                                                                                                                                                AccessTokenSet
                                                                                                                                                                                                                                                                                                                                                                                                Auth0ClientOptions
                                                                                                                                                                                                                                                                                                                                                                                                Authenticator
                                                                                                                                                                                                                                                                                                                                                                                                AuthorizationDetails
                                                                                                                                                                                                                                                                                                                                                                                                AuthorizationParameters
                                                                                                                                                                                                                                                                                                                                                                                                BackchannelAuthenticationOptions
                                                                                                                                                                                                                                                                                                                                                                                                BackchannelAuthenticationResponse
                                                                                                                                                                                                                                                                                                                                                                                                ChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                ConnectAccountOptions
                                                                                                                                                                                                                                                                                                                                                                                                ConnectionTokenSet
                                                                                                                                                                                                                                                                                                                                                                                                CookieOptions
                                                                                                                                                                                                                                                                                                                                                                                                CustomTokenExchangeOptions
                                                                                                                                                                                                                                                                                                                                                                                                CustomTokenExchangeResponse
                                                                                                                                                                                                                                                                                                                                                                                                DiscoveryCacheOptions
                                                                                                                                                                                                                                                                                                                                                                                                EnrollOobOptions
                                                                                                                                                                                                                                                                                                                                                                                                EnrollOtpOptions
                                                                                                                                                                                                                                                                                                                                                                                                MCDMetadata
                                                                                                                                                                                                                                                                                                                                                                                                MfaClient
                                                                                                                                                                                                                                                                                                                                                                                                MfaContext
                                                                                                                                                                                                                                                                                                                                                                                                MfaVerifyResponse
                                                                                                                                                                                                                                                                                                                                                                                                Routes
                                                                                                                                                                                                                                                                                                                                                                                                SessionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                SessionCookieOptions
                                                                                                                                                                                                                                                                                                                                                                                                SessionData
                                                                                                                                                                                                                                                                                                                                                                                                SessionDataStore
                                                                                                                                                                                                                                                                                                                                                                                                SessionStoreOptions
                                                                                                                                                                                                                                                                                                                                                                                                StartInteractiveLoginOptions
                                                                                                                                                                                                                                                                                                                                                                                                TokenSet
                                                                                                                                                                                                                                                                                                                                                                                                TransactionCookieOptions
                                                                                                                                                                                                                                                                                                                                                                                                TransactionState
                                                                                                                                                                                                                                                                                                                                                                                                TransactionStoreOptions
                                                                                                                                                                                                                                                                                                                                                                                                User
                                                                                                                                                                                                                                                                                                                                                                                                VerifyMfaOptionsBase
                                                                                                                                                                                                                                                                                                                                                                                                VerifyMfaWithOobOptions
                                                                                                                                                                                                                                                                                                                                                                                                VerifyMfaWithOtpOptions
                                                                                                                                                                                                                                                                                                                                                                                                VerifyMfaWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                BeforeSessionSavedHook
                                                                                                                                                                                                                                                                                                                                                                                                DomainResolver
                                                                                                                                                                                                                                                                                                                                                                                                EnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                                                EnrollOptions
                                                                                                                                                                                                                                                                                                                                                                                                GetAccessTokenOptions
                                                                                                                                                                                                                                                                                                                                                                                                LogoutStrategy
                                                                                                                                                                                                                                                                                                                                                                                                LogoutToken
                                                                                                                                                                                                                                                                                                                                                                                                OnCallbackContext
                                                                                                                                                                                                                                                                                                                                                                                                OnCallbackHook
                                                                                                                                                                                                                                                                                                                                                                                                PagesRouterRequest
                                                                                                                                                                                                                                                                                                                                                                                                PagesRouterResponse
                                                                                                                                                                                                                                                                                                                                                                                                ProxyOptions
                                                                                                                                                                                                                                                                                                                                                                                                ReadonlyRequestCookies
                                                                                                                                                                                                                                                                                                                                                                                                RoutesOptions
                                                                                                                                                                                                                                                                                                                                                                                                VerifyMfaOptions

                                                                                                                                                                                                                                                                                                                                                                                                Variables

                                                                                                                                                                                                                                                                                                                                                                                                GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE
                                                                                                                                                                                                                                                                                                                                                                                                GRANT_TYPE_MFA_OOB
                                                                                                                                                                                                                                                                                                                                                                                                GRANT_TYPE_MFA_OTP
                                                                                                                                                                                                                                                                                                                                                                                                GRANT_TYPE_MFA_RECOVERY_CODE

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                Enumerations
                                                                                                                                                                                                                                                                                                                                                                                                Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                Variables
                                                                                                                                                                                                                                                                                                                                                                                                +types | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                  Module types

                                                                                                                                                                                                                                                                                                                                                                                                  Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                  RESPONSE_TYPES
                                                                                                                                                                                                                                                                                                                                                                                                  SUBJECT_TOKEN_TYPES

                                                                                                                                                                                                                                                                                                                                                                                                  Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                  AccessTokenForConnectionOptions
                                                                                                                                                                                                                                                                                                                                                                                                  AccessTokenSet
                                                                                                                                                                                                                                                                                                                                                                                                  Auth0ClientOptions
                                                                                                                                                                                                                                                                                                                                                                                                  Authenticator
                                                                                                                                                                                                                                                                                                                                                                                                  AuthorizationDetails
                                                                                                                                                                                                                                                                                                                                                                                                  AuthorizationParameters
                                                                                                                                                                                                                                                                                                                                                                                                  BackchannelAuthenticationOptions
                                                                                                                                                                                                                                                                                                                                                                                                  BackchannelAuthenticationResponse
                                                                                                                                                                                                                                                                                                                                                                                                  ChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                  ConnectAccountOptions
                                                                                                                                                                                                                                                                                                                                                                                                  ConnectionTokenSet
                                                                                                                                                                                                                                                                                                                                                                                                  CookieOptions
                                                                                                                                                                                                                                                                                                                                                                                                  CustomTokenExchangeOptions
                                                                                                                                                                                                                                                                                                                                                                                                  CustomTokenExchangeResponse
                                                                                                                                                                                                                                                                                                                                                                                                  DiscoveryCacheOptions
                                                                                                                                                                                                                                                                                                                                                                                                  EnrollOobOptions
                                                                                                                                                                                                                                                                                                                                                                                                  EnrollOtpOptions
                                                                                                                                                                                                                                                                                                                                                                                                  MCDMetadata
                                                                                                                                                                                                                                                                                                                                                                                                  MfaClient
                                                                                                                                                                                                                                                                                                                                                                                                  MfaContext
                                                                                                                                                                                                                                                                                                                                                                                                  MfaVerifyResponse
                                                                                                                                                                                                                                                                                                                                                                                                  Routes
                                                                                                                                                                                                                                                                                                                                                                                                  SessionConfiguration
                                                                                                                                                                                                                                                                                                                                                                                                  SessionCookieOptions
                                                                                                                                                                                                                                                                                                                                                                                                  SessionData
                                                                                                                                                                                                                                                                                                                                                                                                  SessionDataStore
                                                                                                                                                                                                                                                                                                                                                                                                  SessionStoreOptions
                                                                                                                                                                                                                                                                                                                                                                                                  StartInteractiveLoginOptions
                                                                                                                                                                                                                                                                                                                                                                                                  TokenSet
                                                                                                                                                                                                                                                                                                                                                                                                  TransactionCookieOptions
                                                                                                                                                                                                                                                                                                                                                                                                  TransactionState
                                                                                                                                                                                                                                                                                                                                                                                                  TransactionStoreOptions
                                                                                                                                                                                                                                                                                                                                                                                                  User
                                                                                                                                                                                                                                                                                                                                                                                                  VerifyMfaOptionsBase
                                                                                                                                                                                                                                                                                                                                                                                                  VerifyMfaWithOobOptions
                                                                                                                                                                                                                                                                                                                                                                                                  VerifyMfaWithOtpOptions
                                                                                                                                                                                                                                                                                                                                                                                                  VerifyMfaWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                  BeforeSessionSavedHook
                                                                                                                                                                                                                                                                                                                                                                                                  DomainResolver
                                                                                                                                                                                                                                                                                                                                                                                                  EnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                                                  EnrollOptions
                                                                                                                                                                                                                                                                                                                                                                                                  GetAccessTokenOptions
                                                                                                                                                                                                                                                                                                                                                                                                  LogoutStrategy
                                                                                                                                                                                                                                                                                                                                                                                                  LogoutToken
                                                                                                                                                                                                                                                                                                                                                                                                  OnCallbackContext
                                                                                                                                                                                                                                                                                                                                                                                                  OnCallbackHook
                                                                                                                                                                                                                                                                                                                                                                                                  PagesRouterRequest
                                                                                                                                                                                                                                                                                                                                                                                                  PagesRouterResponse
                                                                                                                                                                                                                                                                                                                                                                                                  ProxyOptions
                                                                                                                                                                                                                                                                                                                                                                                                  ReadonlyRequestCookies
                                                                                                                                                                                                                                                                                                                                                                                                  RoutesOptions
                                                                                                                                                                                                                                                                                                                                                                                                  VerifyMfaOptions

                                                                                                                                                                                                                                                                                                                                                                                                  Variables

                                                                                                                                                                                                                                                                                                                                                                                                  GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE
                                                                                                                                                                                                                                                                                                                                                                                                  GRANT_TYPE_MFA_OOB
                                                                                                                                                                                                                                                                                                                                                                                                  GRANT_TYPE_MFA_OTP
                                                                                                                                                                                                                                                                                                                                                                                                  GRANT_TYPE_MFA_RECOVERY_CODE

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  Enumerations
                                                                                                                                                                                                                                                                                                                                                                                                  Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                  Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                  Variables
                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/client.WithPageAuthRequired.html b/docs/types/client.WithPageAuthRequired.html index 5f69831ec..a7c911f9c 100644 --- a/docs/types/client.WithPageAuthRequired.html +++ b/docs/types/client.WithPageAuthRequired.html @@ -1,6 +1,6 @@ -WithPageAuthRequired | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias WithPageAuthRequired

                                                                                                                                                                                                                                                                                                                                                                                                    WithPageAuthRequired: <P extends object>(
                                                                                                                                                                                                                                                                                                                                                                                                        Component: ComponentType<P & UserProps>,
                                                                                                                                                                                                                                                                                                                                                                                                        options?: WithPageAuthRequiredOptions,
                                                                                                                                                                                                                                                                                                                                                                                                    ) => React.FC<P>
                                                                                                                                                                                                                                                                                                                                                                                                    const MyProtectedPage = withPageAuthRequired(MyPage);
+WithPageAuthRequired | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias WithPageAuthRequired
                                                                                                                                                                                                                                                                                                                                                                                                      WithPageAuthRequired: <P extends object>(
                                                                                                                                                                                                                                                                                                                                                                                                          Component: ComponentType<P & UserProps>,
                                                                                                                                                                                                                                                                                                                                                                                                          options?: WithPageAuthRequiredOptions,
                                                                                                                                                                                                                                                                                                                                                                                                      ) => React.FC<P>
                                                                                                                                                                                                                                                                                                                                                                                                      const MyProtectedPage = withPageAuthRequired(MyPage);
 
                                                                                                                                                                                                                                                                                                                                                                                                      
 
 
                                                                                                                                                                                                                                                                                                                                                                                                      When you wrap your pages in this higher order component and an anonymous user visits your page,
 they will be redirected to the login page and then returned to the page they were redirected from (after login).
                                                                                                                                                                                                                                                                                                                                                                                                      
-
                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration
                                                                                                                                                                                                                                                                                                                                                                                                      Settings
                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                      
+

                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/server.AppRouterPageRoute.html b/docs/types/server.AppRouterPageRoute.html index a1eb7024a..273698a67 100644 --- a/docs/types/server.AppRouterPageRoute.html +++ b/docs/types/server.AppRouterPageRoute.html @@ -1,8 +1,8 @@ -AppRouterPageRoute | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias AppRouterPageRoute<P>

                                                                                                                                                                                                                                                                                                                                                                                                        AppRouterPageRoute: (obj: P) => Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                        An app route that has been augmented with WithPageAuthRequired. +AppRouterPageRoute | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias AppRouterPageRoute<P>

                                                                                                                                                                                                                                                                                                                                                                                                          AppRouterPageRoute: (obj: P) => Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                          An app route that has been augmented with WithPageAuthRequired. Returns any to be compatible with React's return types while avoiding React dependency.

                                                                                                                                                                                                                                                                                                                                                                                                          The generic parameter P allows passing Next.js PageProps or LayoutProps types for strongly-typed route parameters:

                                                                                                                                                                                                                                                                                                                                                                                                          export default auth0.withPageAuthRequired(
                                                                                                                                                                                                                                                                                                                                                                                                            async function Page(props: PageProps<"/customers/[id]/details">) {
                                                                                                                                                                                                                                                                                                                                                                                                              const { id } = await props.params;
                                                                                                                                                                                                                                                                                                                                                                                                              return <div>{id}</div>;
                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                          );
                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                            • (obj: P): Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                              • obj: P

                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                            • (obj: P): Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                              • obj: P

                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/server.AppRouterPageRouteOpts.html b/docs/types/server.AppRouterPageRouteOpts.html index 2debbe8da..a01cf2bf7 100644 --- a/docs/types/server.AppRouterPageRouteOpts.html +++ b/docs/types/server.AppRouterPageRouteOpts.html @@ -1,4 +1,4 @@ -AppRouterPageRouteOpts | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias AppRouterPageRouteOpts

                                                                                                                                                                                                                                                                                                                                                                                                            Objects containing the route parameters and search parameters of the page.

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            type AppRouterPageRouteOpts = {
                                                                                                                                                                                                                                                                                                                                                                                                                params?: Promise<Record<string, string | string[]>>;
                                                                                                                                                                                                                                                                                                                                                                                                                searchParams?: Promise<{ [key: string]: string | string[] | undefined }>;
                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                            params? +AppRouterPageRouteOpts | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias AppRouterPageRouteOpts

                                                                                                                                                                                                                                                                                                                                                                                                              Objects containing the route parameters and search parameters of the page.

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              type AppRouterPageRouteOpts = {
                                                                                                                                                                                                                                                                                                                                                                                                                  params?: Promise<Record<string, string | string[]>>;
                                                                                                                                                                                                                                                                                                                                                                                                                  searchParams?: Promise<{ [key: string]: string | string[] | undefined }>;
                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                              params? searchParams? -

                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                              params?: Promise<Record<string, string | string[]>>
                                                                                                                                                                                                                                                                                                                                                                                                              searchParams?: Promise<{ [key: string]: string | string[] | undefined }>

                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                              params?: Promise<Record<string, string | string[]>>
                                                                                                                                                                                                                                                                                                                                                                                                              searchParams?: Promise<{ [key: string]: string | string[] | undefined }>

                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/server.GetServerSidePropsResultWithSession.html b/docs/types/server.GetServerSidePropsResultWithSession.html index 95f2936e2..3b204fb28 100644 --- a/docs/types/server.GetServerSidePropsResultWithSession.html +++ b/docs/types/server.GetServerSidePropsResultWithSession.html @@ -1,6 +1,6 @@ -GetServerSidePropsResultWithSession | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias GetServerSidePropsResultWithSession<P>

                                                                                                                                                                                                                                                                                                                                                                                                                GetServerSidePropsResultWithSession: GetServerSidePropsResult<
                                                                                                                                                                                                                                                                                                                                                                                                                    P & { user: User },
                                                                                                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                                                                                                If you wrap your getServerSideProps with WithPageAuthRequired your props object will be augmented with +GetServerSidePropsResultWithSession | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias GetServerSidePropsResultWithSession<P>

                                                                                                                                                                                                                                                                                                                                                                                                                  GetServerSidePropsResultWithSession: GetServerSidePropsResult<
                                                                                                                                                                                                                                                                                                                                                                                                                      P & { user: User },
                                                                                                                                                                                                                                                                                                                                                                                                                  >

                                                                                                                                                                                                                                                                                                                                                                                                                  If you wrap your getServerSideProps with WithPageAuthRequired your props object will be augmented with the user property, which will be the User object.

                                                                                                                                                                                                                                                                                                                                                                                                                  // pages/profile.js
                                                                                                                                                                                                                                                                                                                                                                                                                  import { auth0 } from "@/lib/auth0";

                                                                                                                                                                                                                                                                                                                                                                                                                  export default function Profile({ user }) {
                                                                                                                                                                                                                                                                                                                                                                                                                    return <div>Hello {user.name}</div>;
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  export const getServerSideProps = auth0.withPageAuthRequired();
                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                  • P = any

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                  • P = any

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/server.PageRoute.html b/docs/types/server.PageRoute.html index 10f252000..4d4c2514b 100644 --- a/docs/types/server.PageRoute.html +++ b/docs/types/server.PageRoute.html @@ -1,2 +1,2 @@ -PageRoute | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PageRoute<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                    PageRoute: (
                                                                                                                                                                                                                                                                                                                                                                                                                        ctx: GetServerSidePropsContext<Q>,
                                                                                                                                                                                                                                                                                                                                                                                                                    ) => Promise<GetServerSidePropsResultWithSession<P>>

                                                                                                                                                                                                                                                                                                                                                                                                                    A page route that has been augmented with WithPageAuthRequired.

                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                    • P
                                                                                                                                                                                                                                                                                                                                                                                                                    • Q extends ParsedUrlQuery = ParsedUrlQuery

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                    +PageRoute | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias PageRoute<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                      PageRoute: (
                                                                                                                                                                                                                                                                                                                                                                                                                          ctx: GetServerSidePropsContext<Q>,
                                                                                                                                                                                                                                                                                                                                                                                                                      ) => Promise<GetServerSidePropsResultWithSession<P>>

                                                                                                                                                                                                                                                                                                                                                                                                                      A page route that has been augmented with WithPageAuthRequired.

                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                      • P
                                                                                                                                                                                                                                                                                                                                                                                                                      • Q extends ParsedUrlQuery = ParsedUrlQuery

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/server.WithPageAuthRequired.html b/docs/types/server.WithPageAuthRequired.html index 576295a7e..9dff22c1a 100644 --- a/docs/types/server.WithPageAuthRequired.html +++ b/docs/types/server.WithPageAuthRequired.html @@ -1,3 +1,3 @@ -WithPageAuthRequired | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias WithPageAuthRequired

                                                                                                                                                                                                                                                                                                                                                                                                                        WithPageAuthRequired: WithPageAuthRequiredPageRouter & WithPageAuthRequiredAppRouter

                                                                                                                                                                                                                                                                                                                                                                                                                        Protects Page router pages WithPageAuthRequiredPageRouter or +WithPageAuthRequired | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias WithPageAuthRequired

                                                                                                                                                                                                                                                                                                                                                                                                                          WithPageAuthRequired: WithPageAuthRequiredPageRouter & WithPageAuthRequiredAppRouter

                                                                                                                                                                                                                                                                                                                                                                                                                          Protects Page router pages WithPageAuthRequiredPageRouter or App router pages WithPageAuthRequiredAppRouter

                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/server.WithPageAuthRequiredAppRouter.html b/docs/types/server.WithPageAuthRequiredAppRouter.html index 60e997094..07f97f9c7 100644 --- a/docs/types/server.WithPageAuthRequiredAppRouter.html +++ b/docs/types/server.WithPageAuthRequiredAppRouter.html @@ -1,4 +1,4 @@ -WithPageAuthRequiredAppRouter | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias WithPageAuthRequiredAppRouter

                                                                                                                                                                                                                                                                                                                                                                                                                            WithPageAuthRequiredAppRouter: <
                                                                                                                                                                                                                                                                                                                                                                                                                                P extends AppRouterPageRouteOpts = AppRouterPageRouteOpts,
                                                                                                                                                                                                                                                                                                                                                                                                                            >(
                                                                                                                                                                                                                                                                                                                                                                                                                                fn: AppRouterPageRoute<P>,
                                                                                                                                                                                                                                                                                                                                                                                                                                opts?: WithPageAuthRequiredAppRouterOptions<P>,
                                                                                                                                                                                                                                                                                                                                                                                                                            ) => AppRouterPageRoute<P>

                                                                                                                                                                                                                                                                                                                                                                                                                            Wrap your Server Component with this method to make sure the user is authenticated before +WithPageAuthRequiredAppRouter | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias WithPageAuthRequiredAppRouter

                                                                                                                                                                                                                                                                                                                                                                                                                              WithPageAuthRequiredAppRouter: <
                                                                                                                                                                                                                                                                                                                                                                                                                                  P extends AppRouterPageRouteOpts = AppRouterPageRouteOpts,
                                                                                                                                                                                                                                                                                                                                                                                                                              >(
                                                                                                                                                                                                                                                                                                                                                                                                                                  fn: AppRouterPageRoute<P>,
                                                                                                                                                                                                                                                                                                                                                                                                                                  opts?: WithPageAuthRequiredAppRouterOptions<P>,
                                                                                                                                                                                                                                                                                                                                                                                                                              ) => AppRouterPageRoute<P>

                                                                                                                                                                                                                                                                                                                                                                                                                              Wrap your Server Component with this method to make sure the user is authenticated before visiting the page.

                                                                                                                                                                                                                                                                                                                                                                                                                              // app/protected-page/page.js
                                                                                                                                                                                                                                                                                                                                                                                                                              import { auth0 } from "@/lib/auth0";

                                                                                                                                                                                                                                                                                                                                                                                                                              const ProtectedPage = auth0.withPageAuthRequired(async function ProtectedPage() {
                                                                                                                                                                                                                                                                                                                                                                                                                                return <div>Protected content</div>;
                                                                                                                                                                                                                                                                                                                                                                                                                              }, { returnTo: '/protected-page' });

                                                                                                                                                                                                                                                                                                                                                                                                                              export default ProtectedPage;
                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -14,4 +14,4 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                              // app/protected-page/[slug]/page.js
                                                                                                                                                                                                                                                                                                                                                                                                                              import { AppRouterPageRouteOpts } from '@auth0/nextjs-auth0/server';
                                                                                                                                                                                                                                                                                                                                                                                                                              import { auth0 } from "@/lib/auth0";

                                                                                                                                                                                                                                                                                                                                                                                                                              const ProtectedPage = auth0.withPageAuthRequired(async function ProtectedPage({
                                                                                                                                                                                                                                                                                                                                                                                                                                params, searchParams
                                                                                                                                                                                                                                                                                                                                                                                                                              }: AppRouterPageRouteOpts) {
                                                                                                                                                                                                                                                                                                                                                                                                                                const slug = (await params)?.slug as string;
                                                                                                                                                                                                                                                                                                                                                                                                                                return <div>Protected content for {slug}</div>;
                                                                                                                                                                                                                                                                                                                                                                                                                              }, {
                                                                                                                                                                                                                                                                                                                                                                                                                                returnTo({ params }) {
                                                                                                                                                                                                                                                                                                                                                                                                                                  return `/protected-page/${(await params)?.slug}`;
                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                              });

                                                                                                                                                                                                                                                                                                                                                                                                                              export default ProtectedPage;
                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/server.WithPageAuthRequiredAppRouterOptions.html b/docs/types/server.WithPageAuthRequiredAppRouterOptions.html index 5cc57b61b..5e8149c03 100644 --- a/docs/types/server.WithPageAuthRequiredAppRouterOptions.html +++ b/docs/types/server.WithPageAuthRequiredAppRouterOptions.html @@ -1,13 +1,13 @@ -WithPageAuthRequiredAppRouterOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias WithPageAuthRequiredAppRouterOptions<P>

                                                                                                                                                                                                                                                                                                                                                                                                                                Specify the URL to returnTo - this is important in app router pages because the server component +WithPageAuthRequiredAppRouterOptions | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias WithPageAuthRequiredAppRouterOptions<P>

                                                                                                                                                                                                                                                                                                                                                                                                                                  Specify the URL to returnTo - this is important in app router pages because the server component won't know the URL of the page. *

                                                                                                                                                                                                                                                                                                                                                                                                                                  type WithPageAuthRequiredAppRouterOptions<
                                                                                                                                                                                                                                                                                                                                                                                                                                      P extends AppRouterPageRouteOpts = AppRouterPageRouteOpts,
                                                                                                                                                                                                                                                                                                                                                                                                                                  > = {
                                                                                                                                                                                                                                                                                                                                                                                                                                      returnTo?: string | ((obj: P) => Promise<string> | string);
                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                  returnTo? +
                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                  returnTo?

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                  returnTo?: string | ((obj: P) => Promise<string> | string)

                                                                                                                                                                                                                                                                                                                                                                                                                                  The URL to redirect the user to after a successful login.

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Can be a static string or a function that receives the page props. When used as a function, the generic P ensures that params and searchParams match the specific types of your route (e.g., from Next.js PageProps).
                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/server.WithPageAuthRequiredPageRouter.html b/docs/types/server.WithPageAuthRequiredPageRouter.html index 5447a7d8a..84d9f3100 100644 --- a/docs/types/server.WithPageAuthRequiredPageRouter.html +++ b/docs/types/server.WithPageAuthRequiredPageRouter.html @@ -1,8 +1,8 @@ -WithPageAuthRequiredPageRouter | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias WithPageAuthRequiredPageRouter

                                                                                                                                                                                                                                                                                                                                                                                                                                    WithPageAuthRequiredPageRouter: <
                                                                                                                                                                                                                                                                                                                                                                                                                                        P extends { [key: string]: any } = { [key: string]: any },
                                                                                                                                                                                                                                                                                                                                                                                                                                        Q extends ParsedUrlQuery = ParsedUrlQuery,
                                                                                                                                                                                                                                                                                                                                                                                                                                    >(
                                                                                                                                                                                                                                                                                                                                                                                                                                        opts?: WithPageAuthRequiredPageRouterOptions<P, Q>,
                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => PageRoute<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                                    Wrap your getServerSideProps with this method to make sure the user is authenticated before +WithPageAuthRequiredPageRouter | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias WithPageAuthRequiredPageRouter

                                                                                                                                                                                                                                                                                                                                                                                                                                      WithPageAuthRequiredPageRouter: <
                                                                                                                                                                                                                                                                                                                                                                                                                                          P extends { [key: string]: any } = { [key: string]: any },
                                                                                                                                                                                                                                                                                                                                                                                                                                          Q extends ParsedUrlQuery = ParsedUrlQuery,
                                                                                                                                                                                                                                                                                                                                                                                                                                      >(
                                                                                                                                                                                                                                                                                                                                                                                                                                          opts?: WithPageAuthRequiredPageRouterOptions<P, Q>,
                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => PageRoute<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                                      Wrap your getServerSideProps with this method to make sure the user is authenticated before visiting the page.

                                                                                                                                                                                                                                                                                                                                                                                                                                      // pages/protected-page.js
                                                                                                                                                                                                                                                                                                                                                                                                                                      import { auth0 } from "@/lib/auth0";

                                                                                                                                                                                                                                                                                                                                                                                                                                      export default function ProtectedPage() {
                                                                                                                                                                                                                                                                                                                                                                                                                                        return <div>Protected content</div>;
                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                      export const getServerSideProps = auth0.withPageAuthRequired();

                                                                                                                                                                                                                                                                                                                                                                                                                                      If the user visits /protected-page without a valid session, it will redirect the user to the login page. Then they will be returned to /protected-page after login.

                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/server.WithPageAuthRequiredPageRouterOptions.html b/docs/types/server.WithPageAuthRequiredPageRouterOptions.html index c1a9a3404..467413672 100644 --- a/docs/types/server.WithPageAuthRequiredPageRouterOptions.html +++ b/docs/types/server.WithPageAuthRequiredPageRouterOptions.html @@ -1,10 +1,10 @@ -WithPageAuthRequiredPageRouterOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias WithPageAuthRequiredPageRouterOptions<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                                        If you have a custom returnTo url you should specify it in returnTo.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +WithPageAuthRequiredPageRouterOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias WithPageAuthRequiredPageRouterOptions<P, Q>

                                                                                                                                                                                                                                                                                                                                                                                                                                          If you have a custom returnTo url you should specify it in returnTo.

                                                                                                                                                                                                                                                                                                                                                                                                                                          You can pass in your own getServerSideProps method, the props returned from this will be merged with the user props. You can also access the user session data by calling getSession inside of this method. For example:

                                                                                                                                                                                                                                                                                                                                                                                                                                          // pages/protected-page.js
                                                                                                                                                                                                                                                                                                                                                                                                                                          import { auth0 } from "@/lib/auth0";

                                                                                                                                                                                                                                                                                                                                                                                                                                          export default function ProtectedPage({ user, customProp }) {
                                                                                                                                                                                                                                                                                                                                                                                                                                            return <div>Protected content</div>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                          export const getServerSideProps = auth0.withPageAuthRequired({
                                                                                                                                                                                                                                                                                                                                                                                                                                            // returnTo: '/unauthorized',
                                                                                                                                                                                                                                                                                                                                                                                                                                            async getServerSideProps(ctx) {
                                                                                                                                                                                                                                                                                                                                                                                                                                              // access the user session if needed
                                                                                                                                                                                                                                                                                                                                                                                                                                              // const session = await auth0.getSession(ctx.req);
                                                                                                                                                                                                                                                                                                                                                                                                                                              return {
                                                                                                                                                                                                                                                                                                                                                                                                                                                props: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                  // customProp: 'bar',
                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          type WithPageAuthRequiredPageRouterOptions<
                                                                                                                                                                                                                                                                                                                                                                                                                                              P extends { [key: string]: any } = { [key: string]: any },
                                                                                                                                                                                                                                                                                                                                                                                                                                              Q extends ParsedUrlQuery = ParsedUrlQuery,
                                                                                                                                                                                                                                                                                                                                                                                                                                          > = {
                                                                                                                                                                                                                                                                                                                                                                                                                                              getServerSideProps?: GetServerSideProps<P, Q>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              returnTo?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • P extends { [key: string]: any } = { [key: string]: any }
                                                                                                                                                                                                                                                                                                                                                                                                                                          • Q extends ParsedUrlQuery = ParsedUrlQuery
                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                          getServerSideProps? +
                                                                                                                                                                                                                                                                                                                                                                                                                                          type WithPageAuthRequiredPageRouterOptions<
                                                                                                                                                                                                                                                                                                                                                                                                                                              P extends { [key: string]: any } = { [key: string]: any },
                                                                                                                                                                                                                                                                                                                                                                                                                                              Q extends ParsedUrlQuery = ParsedUrlQuery,
                                                                                                                                                                                                                                                                                                                                                                                                                                          > = {
                                                                                                                                                                                                                                                                                                                                                                                                                                              getServerSideProps?: GetServerSideProps<P, Q>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              returnTo?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                          • P extends { [key: string]: any } = { [key: string]: any }
                                                                                                                                                                                                                                                                                                                                                                                                                                          • Q extends ParsedUrlQuery = ParsedUrlQuery
                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                          getServerSideProps? returnTo? -

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                          getServerSideProps?: GetServerSideProps<P, Q>
                                                                                                                                                                                                                                                                                                                                                                                                                                          returnTo?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                          getServerSideProps?: GetServerSideProps<P, Q>
                                                                                                                                                                                                                                                                                                                                                                                                                                          returnTo?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/testing.GenerateSessionCookieConfig.html b/docs/types/testing.GenerateSessionCookieConfig.html index 97d6f79d0..c389b128a 100644 --- a/docs/types/testing.GenerateSessionCookieConfig.html +++ b/docs/types/testing.GenerateSessionCookieConfig.html @@ -1,4 +1,4 @@ -GenerateSessionCookieConfig | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias GenerateSessionCookieConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                            type GenerateSessionCookieConfig = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                secret: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                            secret +GenerateSessionCookieConfig | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias GenerateSessionCookieConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                              type GenerateSessionCookieConfig = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                  secret: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                              secret

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                              secret: string

                                                                                                                                                                                                                                                                                                                                                                                                                                              The secret used to derive an encryption key for the session cookie.

                                                                                                                                                                                                                                                                                                                                                                                                                                              IMPORTANT: you must use the same value as in the SDK configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/types.BeforeSessionSavedHook.html b/docs/types/types.BeforeSessionSavedHook.html index 4f017e44c..61f440347 100644 --- a/docs/types/types.BeforeSessionSavedHook.html +++ b/docs/types/types.BeforeSessionSavedHook.html @@ -1 +1 @@ -BeforeSessionSavedHook | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias BeforeSessionSavedHook

                                                                                                                                                                                                                                                                                                                                                                                                                                                BeforeSessionSavedHook: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                    session: SessionData,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    idToken: string | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => Promise<SessionData>

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                +BeforeSessionSavedHook | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias BeforeSessionSavedHook

                                                                                                                                                                                                                                                                                                                                                                                                                                                  BeforeSessionSavedHook: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                      session: SessionData,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      idToken: string | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => Promise<SessionData>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/types.DomainResolver.html b/docs/types/types.DomainResolver.html index a0b1ba8d7..ae52cd03f 100644 --- a/docs/types/types.DomainResolver.html +++ b/docs/types/types.DomainResolver.html @@ -1,4 +1,4 @@ -DomainResolver | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias DomainResolver

                                                                                                                                                                                                                                                                                                                                                                                                                                                    DomainResolver: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                        config: { headers: Headers; url?: URL },
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => Promise<string> | string

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Resolves the Auth0 domain from request context. +DomainResolver | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias DomainResolver

                                                                                                                                                                                                                                                                                                                                                                                                                                                      DomainResolver: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                          config: { headers: Headers; url?: URL },
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => Promise<string> | string

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Resolves the Auth0 domain from request context. Called once per SDK operation in resolver mode.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Supports both synchronous and asynchronous resolution patterns.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • (config: { headers: Headers; url?: URL }): Promise<string> | string

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • config: { headers: Headers; url?: URL }
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • headers: Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Request headers from the current context. @@ -22,4 +22,4 @@ 

                                                                                                                                                                                                                                                                                                                                                                                                                                                              // Database lookup (B2B SaaS)
                                                                                                                                                                                                                                                                                                                                                                                                                                                              const auth0 = new Auth0Client({
                                                                                                                                                                                                                                                                                                                                                                                                                                                                domain: async ({ headers }) => {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const tenantId = headers.get("x-tenant-id");
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const domain = await db.getAuth0Domain(tenantId);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  if (!domain) throw new Error(`Unknown tenant: ${tenantId}`);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  return domain;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                              });

                                                                                                                                                                                                                                                                                                                                                                                                                                                              @public
                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/types.EnrollOptions.html b/docs/types/types.EnrollOptions.html index d26c2f15f..56bf9faf8 100644 --- a/docs/types/types.EnrollOptions.html +++ b/docs/types/types.EnrollOptions.html @@ -1,2 +1,2 @@ -EnrollOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias EnrollOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                        EnrollOptions: EnrollOtpOptions | EnrollOobOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                        MFA enrollment options (discriminated union).

                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +EnrollOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias EnrollOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollOptions: EnrollOtpOptions | EnrollOobOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                          MFA enrollment options (discriminated union).

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/types.EnrollmentResponse.html b/docs/types/types.EnrollmentResponse.html index 7e393b70b..2c19046e5 100644 --- a/docs/types/types.EnrollmentResponse.html +++ b/docs/types/types.EnrollmentResponse.html @@ -1,2 +1,2 @@ -EnrollmentResponse | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias EnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                            EnrollmentResponse: OtpEnrollmentResponse | OobEnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                            MFA enrollment response (discriminated union).

                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +EnrollmentResponse | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias EnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                              EnrollmentResponse: OtpEnrollmentResponse | OobEnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                              MFA enrollment response (discriminated union).

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/types.GetAccessTokenOptions.html b/docs/types/types.GetAccessTokenOptions.html index 8be23c288..a688cd03f 100644 --- a/docs/types/types.GetAccessTokenOptions.html +++ b/docs/types/types.GetAccessTokenOptions.html @@ -1,7 +1,7 @@ -GetAccessTokenOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias GetAccessTokenOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                type GetAccessTokenOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    audience?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    refresh?: boolean | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scope?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                audience? +GetAccessTokenOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias GetAccessTokenOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type GetAccessTokenOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      audience?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      refresh?: boolean | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scope?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  audience? refresh? scope?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  audience?: string | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Please note: If you are passing audience, ensure that the used audiences and scopes are part of the Application's Refresh Token Policies in Auth0 when configuring Multi-Resource Refresh Tokens (MRRT). Auth0 Documentation on Multi-resource Refresh Tokens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  refresh?: boolean | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  scope?: string | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  refresh?: boolean | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  scope?: string | null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/types.LogoutStrategy.html b/docs/types/types.LogoutStrategy.html index ec6d6c365..01b1a5810 100644 --- a/docs/types/types.LogoutStrategy.html +++ b/docs/types/types.LogoutStrategy.html @@ -1,2 +1,2 @@ -LogoutStrategy | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias LogoutStrategy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    LogoutStrategy: "auto" | "oidc" | "v2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Logout strategy options for controlling logout endpoint selection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +LogoutStrategy | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias LogoutStrategy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LogoutStrategy: "auto" | "oidc" | "v2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Logout strategy options for controlling logout endpoint selection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/types.LogoutToken.html b/docs/types/types.LogoutToken.html index ac01b6e25..976f7f288 100644 --- a/docs/types/types.LogoutToken.html +++ b/docs/types/types.LogoutToken.html @@ -1,4 +1,4 @@ -LogoutToken | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias LogoutToken

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type LogoutToken = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            iss?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sid?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sub?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        iss? +LogoutToken | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias LogoutToken

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type LogoutToken = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              iss?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sid?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sub?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          iss? sid? sub? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          iss?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sid?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sub?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          iss?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sid?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sub?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/types.OnCallbackContext.html b/docs/types/types.OnCallbackContext.html index 03c4a4a0c..4f85259c1 100644 --- a/docs/types/types.OnCallbackContext.html +++ b/docs/types/types.OnCallbackContext.html @@ -1,10 +1,10 @@ -OnCallbackContext | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias OnCallbackContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type OnCallbackContext = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                appBaseUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                connectedAccount?: CompleteConnectAccountResponse;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                responseType?: RESPONSE_TYPES;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                returnTo?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            appBaseUrl? +OnCallbackContext | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias OnCallbackContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type OnCallbackContext = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  appBaseUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  connectedAccount?: CompleteConnectAccountResponse;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  responseType?: RESPONSE_TYPES;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  returnTo?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              appBaseUrl? connectedAccount? responseType? returnTo?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              appBaseUrl?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The resolved base URL for the current request, used to build safe redirects.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              connectedAccount?: CompleteConnectAccountResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The connected account information when the responseType is RESPONSE_TYPES.CONNECT_CODE

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              responseType?: RESPONSE_TYPES

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The type of response expected from the authorization server. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              connectedAccount?: CompleteConnectAccountResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The connected account information when the responseType is RESPONSE_TYPES.CONNECT_CODE

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              responseType?: RESPONSE_TYPES

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The type of response expected from the authorization server. One of RESPONSE_TYPES

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              returnTo?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The URL or path the user should be redirected to after completing the transaction.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              returnTo?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The URL or path the user should be redirected to after completing the transaction.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/types.OnCallbackHook.html b/docs/types/types.OnCallbackHook.html index fd8c2973f..985536195 100644 --- a/docs/types/types.OnCallbackHook.html +++ b/docs/types/types.OnCallbackHook.html @@ -1 +1 @@ -OnCallbackHook | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias OnCallbackHook

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OnCallbackHook: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    error: SdkError | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ctx: OnCallbackContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    session: SessionData | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => Promise<NextResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +OnCallbackHook | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias OnCallbackHook

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OnCallbackHook: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      error: SdkError | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ctx: OnCallbackContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      session: SessionData | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => Promise<NextResponse>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/types.PagesRouterRequest.html b/docs/types/types.PagesRouterRequest.html index 2f06e2f84..8c0ce6565 100644 --- a/docs/types/types.PagesRouterRequest.html +++ b/docs/types/types.PagesRouterRequest.html @@ -1 +1 @@ -PagesRouterRequest | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PagesRouterRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PagesRouterRequest: IncomingMessage | NextApiRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +PagesRouterRequest | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias PagesRouterRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PagesRouterRequest: IncomingMessage | NextApiRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/types.PagesRouterResponse.html b/docs/types/types.PagesRouterResponse.html index 73c56de90..936a54b65 100644 --- a/docs/types/types.PagesRouterResponse.html +++ b/docs/types/types.PagesRouterResponse.html @@ -1 +1 @@ -PagesRouterResponse | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias PagesRouterResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PagesRouterResponse: ServerResponse<IncomingMessage> | NextApiResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +PagesRouterResponse | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias PagesRouterResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PagesRouterResponse: ServerResponse<IncomingMessage> | NextApiResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/types.ProxyOptions.html b/docs/types/types.ProxyOptions.html index 424f20d0e..38f51ae5f 100644 --- a/docs/types/types.ProxyOptions.html +++ b/docs/types/types.ProxyOptions.html @@ -1,5 +1,5 @@ -ProxyOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ProxyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type ProxyOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                audience: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                proxyPath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                scope: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                targetBaseUrl: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            audience +ProxyOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ProxyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type ProxyOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  audience: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  proxyPath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  scope: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  targetBaseUrl: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              audience proxyPath scope targetBaseUrl -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              audience: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              proxyPath: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              scope: string | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              targetBaseUrl: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              audience: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              proxyPath: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              scope: string | null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              targetBaseUrl: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/types.ReadonlyRequestCookies.html b/docs/types/types.ReadonlyRequestCookies.html index 397128475..7ef66c71e 100644 --- a/docs/types/types.ReadonlyRequestCookies.html +++ b/docs/types/types.ReadonlyRequestCookies.html @@ -1 +1 @@ -ReadonlyRequestCookies | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ReadonlyRequestCookies

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ReadonlyRequestCookies: Omit<RequestCookies, "set" | "clear" | "delete"> & Pick<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ResponseCookies,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "set"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "delete",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                >

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +ReadonlyRequestCookies | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ReadonlyRequestCookies

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ReadonlyRequestCookies: Omit<RequestCookies, "set" | "clear" | "delete"> & Pick<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResponseCookies,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "set"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "delete",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  >

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/types.RoutesOptions.html b/docs/types/types.RoutesOptions.html index a3e2a2cdb..b65b596b0 100644 --- a/docs/types/types.RoutesOptions.html +++ b/docs/types/types.RoutesOptions.html @@ -1 +1 @@ -RoutesOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias RoutesOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RoutesOptions: Partial<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Pick<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Routes,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "login"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "callback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "logout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "backChannelLogout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "connectAccount",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        >,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    >

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +RoutesOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias RoutesOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RoutesOptions: Partial<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Pick<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Routes,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "login"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "callback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "logout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "backChannelLogout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "connectAccount",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          >,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      >

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/types.VerifyMfaOptions.html b/docs/types/types.VerifyMfaOptions.html index 70fd020dc..20b334955 100644 --- a/docs/types/types.VerifyMfaOptions.html +++ b/docs/types/types.VerifyMfaOptions.html @@ -1,2 +1,2 @@ -VerifyMfaOptions | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias VerifyMfaOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        VerifyMfaOptions:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | VerifyMfaWithOtpOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | VerifyMfaWithOobOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | VerifyMfaWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        MFA verification options (union type).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +VerifyMfaOptions | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias VerifyMfaOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          VerifyMfaOptions:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | VerifyMfaWithOtpOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | VerifyMfaWithOobOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | VerifyMfaWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MFA verification options (union type).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/variables/client.mfa.html b/docs/variables/client.mfa.html index 1c431dafe..5651ac369 100644 --- a/docs/variables/client.mfa.html +++ b/docs/variables/client.mfa.html @@ -1,5 +1,5 @@ -mfa | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable mfaConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mfa: MfaClient = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Client-side MFA API singleton.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +mfa | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable mfaConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mfa: MfaClient = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Client-side MFA API singleton.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              import { mfa } from '@auth0/nextjs-auth0/client';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              // List authenticators
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              const authenticators = await mfa.getAuthenticators({ mfaToken });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              // Initiate challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              const challenge = await mfa.challenge({ mfaToken, challengeType: 'oob' });

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              // Verify and complete
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              const tokens = await mfa.verify({ mfaToken, otp: '123456' });
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/variables/client.withPageAuthRequired.html b/docs/variables/client.withPageAuthRequired.html index 7a76ae8f3..3655dbf11 100644 --- a/docs/variables/client.withPageAuthRequired.html +++ b/docs/variables/client.withPageAuthRequired.html @@ -1 +1 @@ -withPageAuthRequired | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable withPageAuthRequiredConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                withPageAuthRequired: WithPageAuthRequired = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +withPageAuthRequired | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable withPageAuthRequiredConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  withPageAuthRequired: WithPageAuthRequired = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html b/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html index c05288ebb..a457f584c 100644 --- a/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html +++ b/docs/variables/server.DEFAULT_ID_TOKEN_CLAIMS.html @@ -1,2 +1,2 @@ -DEFAULT_ID_TOKEN_CLAIMS | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable DEFAULT_ID_TOKEN_CLAIMSConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DEFAULT_ID_TOKEN_CLAIMS: string[] = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Default claims for the ID token.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +DEFAULT_ID_TOKEN_CLAIMS | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variable DEFAULT_ID_TOKEN_CLAIMSConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DEFAULT_ID_TOKEN_CLAIMS: string[] = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Default claims for the ID token.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/variables/types.GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE.html b/docs/variables/types.GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE.html index 63a234ce4..5486021ae 100644 --- a/docs/variables/types.GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE.html +++ b/docs/variables/types.GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE.html @@ -1,3 +1,3 @@ -GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Variable GRANT_TYPE_CUSTOM_TOKEN_EXCHANGEConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE: "urn:ietf:params:oauth:grant-type:token-exchange"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Grant type for Custom Token Exchange as per RFC 8693.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable GRANT_TYPE_CUSTOM_TOKEN_EXCHANGEConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GRANT_TYPE_CUSTOM_TOKEN_EXCHANGE: "urn:ietf:params:oauth:grant-type:token-exchange"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Grant type for Custom Token Exchange as per RFC 8693.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RFC 8693

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/variables/types.GRANT_TYPE_MFA_OOB.html b/docs/variables/types.GRANT_TYPE_MFA_OOB.html index 486cfffcc..6c8c6aa44 100644 --- a/docs/variables/types.GRANT_TYPE_MFA_OOB.html +++ b/docs/variables/types.GRANT_TYPE_MFA_OOB.html @@ -1,3 +1,3 @@ -GRANT_TYPE_MFA_OOB | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable GRANT_TYPE_MFA_OOBConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GRANT_TYPE_MFA_OOB: "http://auth0.com/oauth/grant-type/mfa-oob"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Grant type for MFA OOB (SMS/Email/Push) verification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +GRANT_TYPE_MFA_OOB | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable GRANT_TYPE_MFA_OOBConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GRANT_TYPE_MFA_OOB: "http://auth0.com/oauth/grant-type/mfa-oob"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Grant type for MFA OOB (SMS/Email/Push) verification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              https://auth0.com/docs/api/authentication#verify-with-oob

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/variables/types.GRANT_TYPE_MFA_OTP.html b/docs/variables/types.GRANT_TYPE_MFA_OTP.html index b7e2ac58c..edf539382 100644 --- a/docs/variables/types.GRANT_TYPE_MFA_OTP.html +++ b/docs/variables/types.GRANT_TYPE_MFA_OTP.html @@ -1,4 +1,4 @@ -GRANT_TYPE_MFA_OTP | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable GRANT_TYPE_MFA_OTPConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GRANT_TYPE_MFA_OTP: "http://auth0.com/oauth/grant-type/mfa-otp"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Grant type for MFA token exchange. +GRANT_TYPE_MFA_OTP | @auth0/nextjs-auth0 - v4.18.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable GRANT_TYPE_MFA_OTPConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GRANT_TYPE_MFA_OTP: "http://auth0.com/oauth/grant-type/mfa-otp"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Grant type for MFA token exchange. Used in token endpoint requests to exchange an mfa_token for access/refresh tokens.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  https://auth0.com/docs/api/authentication#verify-with-one-time-password-otp-

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/variables/types.GRANT_TYPE_MFA_RECOVERY_CODE.html b/docs/variables/types.GRANT_TYPE_MFA_RECOVERY_CODE.html index 636b1fd6b..fd82e6984 100644 --- a/docs/variables/types.GRANT_TYPE_MFA_RECOVERY_CODE.html +++ b/docs/variables/types.GRANT_TYPE_MFA_RECOVERY_CODE.html @@ -1,3 +1,3 @@ -GRANT_TYPE_MFA_RECOVERY_CODE | @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/nextjs-auth0 - v4.17.1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable GRANT_TYPE_MFA_RECOVERY_CODEConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GRANT_TYPE_MFA_RECOVERY_CODE: "http://auth0.com/oauth/grant-type/mfa-recovery-code"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Grant type for MFA recovery code verification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +GRANT_TYPE_MFA_RECOVERY_CODE | @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/nextjs-auth0 - v4.18.0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variable GRANT_TYPE_MFA_RECOVERY_CODEConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GRANT_TYPE_MFA_RECOVERY_CODE: "http://auth0.com/oauth/grant-type/mfa-recovery-code"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Grant type for MFA recovery code verification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      https://auth0.com/docs/api/authentication#verify-with-recovery-code

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/package.json b/package.json index 9c88e3691..283b3912f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@auth0/nextjs-auth0", - "version": "4.17.1", + "version": "4.18.0", "description": "Auth0 Next.js SDK", "type": "module", "scripts": {