diff --git a/CHANGELOG.md b/CHANGELOG.md index 78c3fb1c7..5334ccfb5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.6.0](https://github.com/auth0/nextjs-auth0/tree/v2.6.0) (2023-05-12) +[Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v2.5.0...v2.6.0) + +**Added** +- Add prefixed url env for preview deploys on middleware [\#1198](https://github.com/auth0/nextjs-auth0/pull/1198) ([adamjmcgrath](https://github.com/adamjmcgrath)) + ## [v2.5.0](https://github.com/auth0/nextjs-auth0/tree/v2.5.0) (2023-04-18) [Full Changelog](https://github.com/auth0/nextjs-auth0/compare/v2.4.0...v2.5.0) diff --git a/docs/assets/main.js b/docs/assets/main.js index 932e185d5..4c8fa615a 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,7 +1,7 @@ "use strict"; -"use strict";(()=>{var be=Object.create;var re=Object.defineProperty;var Se=Object.getOwnPropertyDescriptor;var we=Object.getOwnPropertyNames;var Te=Object.getPrototypeOf,ke=Object.prototype.hasOwnProperty;var Qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Pe=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of we(e))!ke.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=Se(e,i))||n.enumerable});return t};var Ie=(t,e,r)=>(r=t!=null?be(Te(t)):{},Pe(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Qe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},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),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&e?.parentElement?.parentElement!==r&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=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 r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ie(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ce(t,n,r,s)}function Ce(t,e,r,n){r.addEventListener("input",ie(()=>{_e(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Re(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function Oe(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function _e(t,e,r,n){if(Oe(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Re(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Fe={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Fe[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,Me=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(Me=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}addEventListener("load",()=>{de(),G(X,"a[data-toggle]"),G(Z,".tsd-index-accordion"),G(Y,".tsd-filter-item input[type=checkbox]");let t=document.getElementById("tsd-theme");t&&ve(t);let e=new U;Object.defineProperty(window,"app",{value:e})});})(); +"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},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),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=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 r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/style.css b/docs/assets/style.css index da6c789f8..18b4f8fee 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -51,13 +51,13 @@ --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; - --dark-color-ts-project: #e14dff; + --dark-color-ts-project: #e358ff; --dark-color-ts-module: var(--dark-color-ts-project); --dark-color-ts-namespace: var(--dark-color-ts-project); --dark-color-ts-enum: #f4d93e; --dark-color-ts-enum-member: var(--dark-color-ts-enum); --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #9772ff; + --dark-color-ts-function: #a280ff; --dark-color-ts-class: #8ac4ff; --dark-color-ts-interface: #6cff87; --dark-color-ts-constructor: var(--dark-color-ts-class); @@ -262,6 +262,16 @@ h6 { line-height: 1.2; } +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + h1 { font-size: 1.875rem; margin: 0.67rem 0; @@ -296,12 +306,6 @@ h6 { text-transform: uppercase; } -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - dl, menu, ol, @@ -426,13 +430,29 @@ pre { } pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; padding: 10px; - border: 0.1em solid var(--color-accent); + border: 1px solid var(--color-accent); } pre code { padding: 0; font-size: 100%; } +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} blockquote { margin: 1em 0; @@ -676,7 +696,12 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { .tsd-navigation.settings { margin: 1rem 0; } +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} .tsd-navigation a, +.tsd-navigation summary > span, .tsd-page-navigation a { display: inline-flex; align-items: center; @@ -685,14 +710,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { text-decoration: none; box-sizing: border-box; } -.tsd-navigation a { - /* why 3rem? No idea, but it seems to work. */ - width: calc(100% - 3rem); -} -.tsd-page-navigation a { - /* why is this different? */ - width: 100%; -} .tsd-navigation a.current, .tsd-page-navigation a.current { background: var(--color-active-menu-item); @@ -703,7 +720,8 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } .tsd-navigation ul, .tsd-page-navigation ul { - margin: 0; + margin-top: 0; + margin-bottom: 0; padding: 0; list-style: none; } @@ -712,18 +730,24 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { padding: 0; max-width: 100%; } -.tsd-nested-navigation > li > a { +.tsd-nested-navigation { margin-left: 3rem; } .tsd-nested-navigation > li > details { - margin-left: 1.5rem; + margin-left: -1.5rem; } -.tsd-small-nested-navigation > li > a { +.tsd-small-nested-navigation { margin-left: 1.5rem; } .tsd-small-nested-navigation > li > details { - margin-left: 0; + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); } + .tsd-page-navigation ul { padding-left: 1.75rem; } @@ -745,6 +769,13 @@ a.tsd-index-link { align-items: center; color: var(--color-text); } +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} .tsd-accordion-summary, .tsd-accordion-summary a { user-select: none; @@ -752,21 +783,19 @@ a.tsd-index-link { -webkit-user-select: none; -ms-user-select: none; - display: flex; - align-items: center; cursor: pointer; } +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} .tsd-accordion-summary > * { margin-top: 0; margin-bottom: 0; padding-top: 0; padding-bottom: 0; } -.tsd-accordion-summary::-webkit-details-marker { - display: none; -} -.tsd-index-accordion .tsd-accordion-summary svg { - margin-right: 0.25rem; +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; } .tsd-index-content > :not(:first-child) { margin-top: 0.75rem; diff --git a/docs/classes/client_use_user.RequestError.html b/docs/classes/client_use_user.RequestError.html index 4bb9c5b08..b48e49f4f 100644 --- a/docs/classes/client_use_user.RequestError.html +++ b/docs/classes/client_use_user.RequestError.html @@ -30,7 +30,7 @@

Hierarchy

  • RequestError
+
  • Defined in client/use-user.tsx:46
    • @@ -59,14 +59,14 @@
    status: Returns RequestError
    +
  • Defined in client/use-user.tsx:49

    • Properties

    status

    status: number
    +
  • Defined in client/use-user.tsx:47
    • diff --git a/docs/classes/session_session.default.html b/docs/classes/session_session.default.html index ab2360319..a3c5318fa 100644 --- a/docs/classes/session_session.default.html +++ b/docs/classes/session_session.default.html @@ -27,7 +27,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in session/session.ts:19
    • @@ -60,7 +60,7 @@

    Parameters

    user: Claims

    Returns default

    +
  • Defined in session/session.ts:55

    • Properties

    @@ -69,28 +69,28 @@

    Optional

    The access token.

    +
  • Defined in session/session.ts:33

    • Optional accessTokenExpiresAt

    accessTokenExpiresAt?: number

    The expiration of the access token.

    +
  • Defined in session/session.ts:43

    • Optional accessTokenScope

    accessTokenScope?: string

    The access token scopes.

    +
  • Defined in session/session.ts:38

    • Optional idToken

    idToken?: string

    The ID token.

    +
  • Defined in session/session.ts:28

    • Optional refreshToken

    refreshToken?: string
    @@ -99,14 +99,14 @@

    Optional

    +
  • Defined in session/session.ts:51

    • user

    user: Claims

    Any of the claims from the id_token.

    +
  • Defined in session/session.ts:23
    • diff --git a/docs/classes/utils_errors.AccessTokenError.html b/docs/classes/utils_errors.AccessTokenError.html index da0480348..9afd9321d 100644 --- a/docs/classes/utils_errors.AccessTokenError.html +++ b/docs/classes/utils_errors.AccessTokenError.html @@ -34,7 +34,7 @@

    Hierarchy

    • AccessTokenError
    +
  • Defined in utils/errors.ts:99
    • @@ -70,7 +70,7 @@
    Optional Returns AccessTokenError
    +
  • Defined in utils/errors.ts:100

    • Properties

    @@ -84,7 +84,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -95,7 +95,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -103,7 +103,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -111,7 +111,7 @@

    Optional

    +
  • Defined in utils/errors.ts:62
    • diff --git a/docs/classes/utils_errors.AuthError.html b/docs/classes/utils_errors.AuthError.html index d821829dc..caf695d0c 100644 --- a/docs/classes/utils_errors.AuthError.html +++ b/docs/classes/utils_errors.AuthError.html @@ -35,7 +35,7 @@

    Hierarchy

  • AccessTokenError
  • HandlerError
    • +
  • Defined in utils/errors.ts:34
    • @@ -67,7 +67,7 @@
    options: Returns AuthError
    +
  • Defined in utils/errors.ts:64

    • Properties

    @@ -80,7 +80,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -90,7 +90,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -98,14 +98,14 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number

    The HTTP status code, if any.

    +
  • Defined in utils/errors.ts:62
    • diff --git a/docs/classes/utils_errors.CallbackHandlerError.html b/docs/classes/utils_errors.CallbackHandlerError.html index 6325bd727..fac2448eb 100644 --- a/docs/classes/utils_errors.CallbackHandlerError.html +++ b/docs/classes/utils_errors.CallbackHandlerError.html @@ -40,7 +40,7 @@

    Hierarchy

    • CallbackHandlerError
    +
  • Defined in utils/errors.ts:171
    • @@ -73,7 +73,7 @@
    cause: Returns CallbackHandlerError
    +
  • Defined in utils/errors.ts:174

    • Properties

    @@ -87,7 +87,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -98,7 +98,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -106,7 +106,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -114,12 +114,12 @@

    Optional

    +
  • Defined in utils/errors.ts:62

    • Static Readonly code

    code: string = 'ERR_CALLBACK_HANDLER_FAILURE'
    +
  • Defined in utils/errors.ts:172
    • diff --git a/docs/classes/utils_errors.HandlerError.html b/docs/classes/utils_errors.HandlerError.html index 955afff22..80fe1b850 100644 --- a/docs/classes/utils_errors.HandlerError.html +++ b/docs/classes/utils_errors.HandlerError.html @@ -45,7 +45,7 @@

    Hierarchy

  • LogoutHandlerError
  • ProfileHandlerError
    • +
  • Defined in utils/errors.ts:142
    • @@ -77,7 +77,7 @@
    options: Returns HandlerError
    +
  • Defined in utils/errors.ts:143

    • Properties

    @@ -91,7 +91,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -102,7 +102,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -110,7 +110,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -118,7 +118,7 @@

    Optional

    +
  • Defined in utils/errors.ts:62
    • diff --git a/docs/classes/utils_errors.LoginHandlerError.html b/docs/classes/utils_errors.LoginHandlerError.html index c7b0449d4..ea9dea475 100644 --- a/docs/classes/utils_errors.LoginHandlerError.html +++ b/docs/classes/utils_errors.LoginHandlerError.html @@ -28,7 +28,7 @@

    Hierarchy

    • LoginHandlerError
    +
  • Defined in utils/errors.ts:191
    • @@ -61,7 +61,7 @@
    cause: Returns LoginHandlerError
    +
  • Defined in utils/errors.ts:194

    • Properties

    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -86,7 +86,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -94,7 +94,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -102,12 +102,12 @@

    Optional

    +
  • Defined in utils/errors.ts:62

    • Static Readonly code

    code: string = 'ERR_LOGIN_HANDLER_FAILURE'
    +
  • Defined in utils/errors.ts:192
    • diff --git a/docs/classes/utils_errors.LogoutHandlerError.html b/docs/classes/utils_errors.LogoutHandlerError.html index 849889bb1..4b0989b43 100644 --- a/docs/classes/utils_errors.LogoutHandlerError.html +++ b/docs/classes/utils_errors.LogoutHandlerError.html @@ -28,7 +28,7 @@

    Hierarchy

    • LogoutHandlerError
    +
  • Defined in utils/errors.ts:211
    • @@ -61,7 +61,7 @@
    cause: Returns LogoutHandlerError
    +
  • Defined in utils/errors.ts:214

    • Properties

    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -86,7 +86,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -94,7 +94,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -102,12 +102,12 @@

    Optional

    +
  • Defined in utils/errors.ts:62

    • Static Readonly code

    code: string = 'ERR_LOGOUT_HANDLER_FAILURE'
    +
  • Defined in utils/errors.ts:212
    • diff --git a/docs/classes/utils_errors.ProfileHandlerError.html b/docs/classes/utils_errors.ProfileHandlerError.html index 9dcfde8b7..c82572dc6 100644 --- a/docs/classes/utils_errors.ProfileHandlerError.html +++ b/docs/classes/utils_errors.ProfileHandlerError.html @@ -28,7 +28,7 @@

    Hierarchy

    • ProfileHandlerError
    +
  • Defined in utils/errors.ts:231
    • @@ -61,7 +61,7 @@
    cause: Returns ProfileHandlerError
    +
  • Defined in utils/errors.ts:234

    • Properties

    @@ -75,7 +75,7 @@

    Optional

    +
  • Defined in utils/errors.ts:57

    • Readonly code

    code: string
    @@ -86,7 +86,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:41

    • Readonly name

    name: string
    @@ -94,7 +94,7 @@

    Readonly

    +
  • Defined in utils/errors.ts:46

    • Optional Readonly status

    status?: number
    @@ -102,12 +102,12 @@

    Optional

    +
  • Defined in utils/errors.ts:62

    • Static Readonly code

    code: string = 'ERR_PROFILE_HANDLER_FAILURE'
    +
  • Defined in utils/errors.ts:232
    • diff --git a/docs/enums/utils_errors.AccessTokenErrorCode.html b/docs/enums/utils_errors.AccessTokenErrorCode.html index f456c449c..6dfb8e1cc 100644 --- a/docs/enums/utils_errors.AccessTokenErrorCode.html +++ b/docs/enums/utils_errors.AccessTokenErrorCode.html @@ -20,7 +20,7 @@

    Enumeration AccessTokenErrorCode

    Error codes for AccessTokenError.

    +
  • Defined in utils/errors.ts:79
    • @@ -41,32 +41,32 @@

    Enumeration Members

    EXPIRED_ACCESS_TOKEN

    EXPIRED_ACCESS_TOKEN: "ERR_EXPIRED_ACCESS_TOKEN"
    +
  • Defined in utils/errors.ts:83

    • FAILED_REFRESH_GRANT

    FAILED_REFRESH_GRANT: "ERR_FAILED_REFRESH_GRANT"
    +
  • Defined in utils/errors.ts:85

    • INSUFFICIENT_SCOPE

    INSUFFICIENT_SCOPE: "ERR_INSUFFICIENT_SCOPE"
    +
  • Defined in utils/errors.ts:84

    • MISSING_ACCESS_TOKEN

    MISSING_ACCESS_TOKEN: "ERR_MISSING_ACCESS_TOKEN"
    +
  • Defined in utils/errors.ts:81

    • MISSING_REFRESH_TOKEN

    MISSING_REFRESH_TOKEN: "ERR_MISSING_REFRESH_TOKEN"
    +
  • Defined in utils/errors.ts:82

    • MISSING_SESSION

    MISSING_SESSION: "ERR_MISSING_SESSION"
    +
  • Defined in utils/errors.ts:80
    • diff --git a/docs/functions/client_use_user.default.html b/docs/functions/client_use_user.default.html index 614b8b9c1..d7c56e190 100644 --- a/docs/functions/client_use_user.default.html +++ b/docs/functions/client_use_user.default.html @@ -27,7 +27,7 @@

    Parameters

    __namedParameters: UserProviderProps

    Returns ReactElement<UserContext, string | JSXElementConstructor<any>>

    +
  • Defined in client/use-user.tsx:190
    • diff --git a/docs/functions/client_use_user.useUser.html b/docs/functions/client_use_user.useUser.html index e2f5b4ad7..e91d928c1 100644 --- a/docs/functions/client_use_user.useUser.html +++ b/docs/functions/client_use_user.useUser.html @@ -23,11 +23,11 @@

    Function useUser

    The useUser hook, which will get you the UserProfile object from the server-side session by fetching it from the HandleProfile API route.

    // pages/profile.js
    import Link from 'next/link';
    import { useUser } from '@auth0/nextjs-auth0/client';

    export default function Profile() {
      const { user, error, isLoading } = useUser();

      if (isLoading) return <div>Loading...</div>;
      if (error) return <div>{error.message}</div>;
      if (!user) return <Link href="/api/auth/login"><a>Login</a></Link>;
      return <div>Hello {user.name}, <Link href="/api/auth/logout"><a>Logout</a></Link></div>;
    }
-
    +

    Returns UserContext

    +
  • Defined in client/use-user.tsx:134
    • diff --git a/docs/functions/edge.getSession-1.html b/docs/functions/edge.getSession-1.html index 45c68ae13..2f64c5e07 100644 --- a/docs/functions/edge.getSession-1.html +++ b/docs/functions/edge.getSession-1.html @@ -29,7 +29,7 @@
    req: res: NextResponse

    Returns Promise<undefined | null | default>

    +
  • Defined in edge.ts:16
    • diff --git a/docs/functions/edge.initAuth0-1.html b/docs/functions/edge.initAuth0-1.html index c88649b04..c2927eb99 100644 --- a/docs/functions/edge.initAuth0-1.html +++ b/docs/functions/edge.initAuth0-1.html @@ -27,7 +27,7 @@

    Parameters

    Optional params: DeepPartial<BaseConfig & NextConfig>

    Returns Auth0Edge

    +
  • Defined in edge.ts:18
    • diff --git a/docs/functions/edge.withMiddlewareAuthRequired-1.html b/docs/functions/edge.withMiddlewareAuthRequired-1.html index cdd6d7261..cb0ccde21 100644 --- a/docs/functions/edge.withMiddlewareAuthRequired-1.html +++ b/docs/functions/edge.withMiddlewareAuthRequired-1.html @@ -23,14 +23,14 @@

    Function withMiddlewareAuthRequired

    Protect your pages with Next.js Middleware. For example:

    To protect all your routes:

    // middleware.js
    import { withMiddlewareAuthRequired } from '@auth0/nextjs-auth0/edge';

    export default withMiddlewareAuthRequired();
-
    +

    To protect specific routes:

    // middleware.js
    import { withMiddlewareAuthRequired } from '@auth0/nextjs-auth0/edge';

    export default withMiddlewareAuthRequired();

    export const config = {
      matcher: '/about/:path*',
    };
-
    +

    For more info see: https://nextjs.org/docs/advanced-features/middleware#matching-paths

    To run custom middleware for authenticated users:

    // middleware.js
    import { withMiddlewareAuthRequired, getSession } from '@auth0/nextjs-auth0/edge';

    export default withMiddlewareAuthRequired(async function middleware(req) {
      const res = NextResponse.next();
      const user = await getSession(req, res);
      res.cookies.set('hl', user.language);
      return res;
    });
-
    +

    Parameters

    @@ -39,7 +39,7 @@

    Parameters

    Optional middleware: NextMiddleware

    Returns NextMiddleware

    +
  • Defined in helpers/with-middleware-auth-required.ts:46
    • diff --git a/docs/functions/helpers_testing.generateSessionCookie.html b/docs/functions/helpers_testing.generateSessionCookie.html index 1189ee302..7a3998345 100644 --- a/docs/functions/helpers_testing.generateSessionCookie.html +++ b/docs/functions/helpers_testing.generateSessionCookie.html @@ -29,7 +29,7 @@
    session: config: GenerateSessionCookieConfig

    Returns Promise<string>

    +
  • Defined in helpers/testing.ts:23
    • diff --git a/docs/functions/index._initAuth.html b/docs/functions/index._initAuth.html index 00f4fc040..9f1b75648 100644 --- a/docs/functions/index._initAuth.html +++ b/docs/functions/index._initAuth.html @@ -27,7 +27,7 @@

    Parameters

    Optional params: DeepPartial<BaseConfig & NextConfig>

    Returns Auth0Server & {
        sessionCache: default<IncomingMessage | NextApiRequest, ServerResponse<IncomingMessage> | NextApiResponse<any>>;
    }

    +
  • Defined in index.ts:161
    • diff --git a/docs/functions/index.getAccessToken-1.html b/docs/functions/index.getAccessToken-1.html index 46738472f..ed266dce9 100644 --- a/docs/functions/index.getAccessToken-1.html +++ b/docs/functions/index.getAccessToken-1.html @@ -35,7 +35,7 @@
    res: Optional accessTokenRequest: AccessTokenRequest

    Returns Promise<GetAccessTokenResult>

    +
  • Defined in session/get-access-token.ts:86
    • diff --git a/docs/functions/index.getSession-1.html b/docs/functions/index.getSession-1.html index de8928d22..624918439 100644 --- a/docs/functions/index.getSession-1.html +++ b/docs/functions/index.getSession-1.html @@ -31,7 +31,7 @@
    req: res: ServerResponse<IncomingMessage> | NextApiResponse<any>

    Returns Promise<undefined | null | default>

    +
  • Defined in session/get-session.ts:11
    • diff --git a/docs/functions/index.handleAuth-1.html b/docs/functions/index.handleAuth-1.html index fcd2845ee..38046d306 100644 --- a/docs/functions/index.handleAuth-1.html +++ b/docs/functions/index.handleAuth-1.html @@ -24,7 +24,7 @@

    Function handleAuth

    Simply set the environment variables per ConfigParameters then create the file pages/api/auth/[...auth0].js. For example:

    // pages/api/auth/[...auth0].js
    import { handleAuth } from '@auth0/nextjs-auth0';

    export default handleAuth();
-
    +

    This will create 5 handlers for the following urls:

    • /api/auth/login: log the user in to your app by redirecting them to your identity provider.
      • @@ -41,7 +41,7 @@

      Parameters

      Optional userHandlers: Handlers

    Returns NextApiHandler<any>

    +
  • Defined in handlers/auth.ts:94
    • diff --git a/docs/functions/index.handleCallback-1.html b/docs/functions/index.handleCallback-1.html index b9edc8cd3..fa3936edb 100644 --- a/docs/functions/index.handleCallback-1.html +++ b/docs/functions/index.handleCallback-1.html @@ -31,7 +31,7 @@
    res: Optional options: CallbackOptions

    Returns Promise<void>

    +
  • Defined in handlers/callback.ts:185
  • @@ -41,7 +41,7 @@

    Parameters

    provider: CallbackOptionsProvider

    • Returns CallbackHandler

    +
  • Defined in handlers/callback.ts:186
  • @@ -51,7 +51,7 @@

    Parameters

    options: CallbackOptions

    • Returns CallbackHandler

    +
  • Defined in handlers/callback.ts:187
    • diff --git a/docs/functions/index.handleLogin-1.html b/docs/functions/index.handleLogin-1.html index a4e780b1a..a443400ab 100644 --- a/docs/functions/index.handleLogin-1.html +++ b/docs/functions/index.handleLogin-1.html @@ -31,7 +31,7 @@
    res: Optional options: LoginOptions

    Returns Promise<void>

    +
  • Defined in handlers/login.ts:224
  • @@ -41,7 +41,7 @@

    Parameters

    provider: LoginOptionsProvider

    • Returns LoginHandler

    +
  • Defined in handlers/login.ts:225
  • @@ -51,7 +51,7 @@

    Parameters

    options: LoginOptions

    • Returns LoginHandler

    +
  • Defined in handlers/login.ts:226
    • diff --git a/docs/functions/index.handleLogout-1.html b/docs/functions/index.handleLogout-1.html index 4d7989eba..9f720aa37 100644 --- a/docs/functions/index.handleLogout-1.html +++ b/docs/functions/index.handleLogout-1.html @@ -31,7 +31,7 @@
    res: Optional options: LogoutOptions

    Returns Promise<void>

    +
  • Defined in handlers/logout.ts:86
  • @@ -41,7 +41,7 @@

    Parameters

    provider: LogoutOptionsProvider

    • Returns LogoutHandler

    +
  • Defined in handlers/logout.ts:87
  • @@ -51,7 +51,7 @@

    Parameters

    options: LogoutOptions

    • Returns LogoutHandler

    +
  • Defined in handlers/logout.ts:88
    • diff --git a/docs/functions/index.handleProfile-1.html b/docs/functions/index.handleProfile-1.html index b2528db67..999dbeaf5 100644 --- a/docs/functions/index.handleProfile-1.html +++ b/docs/functions/index.handleProfile-1.html @@ -31,7 +31,7 @@
    res: Optional options: ProfileOptions

    Returns Promise<void>

    +
  • Defined in handlers/profile.ts:89
  • @@ -41,7 +41,7 @@

    Parameters

    provider: ProfileOptionsProvider

    • Returns ProfileHandler

    +
  • Defined in handlers/profile.ts:90
  • @@ -51,7 +51,7 @@

    Parameters

    options: ProfileOptions

    • Returns ProfileHandler

    +
  • Defined in handlers/profile.ts:91
    • diff --git a/docs/functions/index.initAuth0-1.html b/docs/functions/index.initAuth0-1.html index 1c4357fb9..5a6f1c426 100644 --- a/docs/functions/index.initAuth0-1.html +++ b/docs/functions/index.initAuth0-1.html @@ -30,7 +30,7 @@

    Parameters

    Optional params: DeepPartial<BaseConfig & NextConfig>

    Returns Auth0Server

    +
  • Defined in index.ts:138
    • diff --git a/docs/functions/index.updateSession-1.html b/docs/functions/index.updateSession-1.html index 3f3ee9744..537ec150c 100644 --- a/docs/functions/index.updateSession-1.html +++ b/docs/functions/index.updateSession-1.html @@ -24,7 +24,7 @@

    Function updateSession

    Note you can't use this method to login or logout - you should use the login and logout handlers for this. If no session is provided, it doesn't contain a user or the user is not authenticated; this is a no-op.

    // pages/api/update-user.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function updateSession(req, res) {
      if (req.method === 'PUT') {
        const session = await getSession(req, res);
        updateSession(req, res, { ...session, user: { ...session.user, foo: req.query.foo } });
        res.json({ success: true });
      }
    };
-
    +

    Parameters

    @@ -37,7 +37,7 @@
    res: user: default

    Returns Promise<void>

    +
  • Defined in session/update-session.ts:27
    • diff --git a/docs/functions/index.withApiAuthRequired-1.html b/docs/functions/index.withApiAuthRequired-1.html index f43d1e4c6..c9cd67b00 100644 --- a/docs/functions/index.withApiAuthRequired-1.html +++ b/docs/functions/index.withApiAuthRequired-1.html @@ -23,7 +23,7 @@

    Function withApiAuthRequired

    Wrap an API route to check that the user has a valid session. If they're not logged in the handler will return a 401 Unauthorized.

    // pages/api/protected-route.js
    import { withApiAuthRequired, getSession } from '@auth0/nextjs-auth0';

    export default withApiAuthRequired(function ProtectedRoute(req, res) {
      const session = getSession(req, res);
      ...
    });
-
    +

    If you visit /api/protected-route without a valid session cookie, you will get a 401 response.

    @@ -33,7 +33,7 @@

    Parameters

    apiRoute: NextApiHandler<any>

    Returns NextApiHandler<any>

    +
  • Defined in helpers/with-api-auth-required.ts:23
    • diff --git a/docs/functions/index.withPageAuthRequired-1.html b/docs/functions/index.withPageAuthRequired-1.html index a386b0c49..f12e9157b 100644 --- a/docs/functions/index.withPageAuthRequired-1.html +++ b/docs/functions/index.withPageAuthRequired-1.html @@ -23,13 +23,13 @@

    Function withPageAuthRequired

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

    // pages/protected-page.js
    import { withPageAuthRequired } from '@auth0/nextjs-auth0';

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

    export const getServerSideProps = 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 Parameters

    -
      +

      • P extends {
            [key: string]: any;
        } = {
            [key: string]: any;
        }

      • @@ -41,7 +41,7 @@

        Parameters

        Optional opts: WithPageAuthRequiredOptions<P, Q>

    Returns PageRoute<P, Q>

    +
  • Defined in helpers/with-page-auth-required.ts:93
    • diff --git a/docs/interfaces/client_use_user.UserProfile.html b/docs/interfaces/client_use_user.UserProfile.html index 14e02e7f7..00a94bf96 100644 --- a/docs/interfaces/client_use_user.UserProfile.html +++ b/docs/interfaces/client_use_user.UserProfile.html @@ -27,7 +27,7 @@

    Hierarchy

    Indexable

    [key: string]: unknown
    +
  • Defined in client/use-user.tsx:11
    • @@ -50,42 +50,42 @@

    Properties

    Optional email

    email?: null | string
    +
  • Defined in client/use-user.tsx:12

    • Optional email_verified

    email_verified?: null | boolean
    +
  • Defined in client/use-user.tsx:13

    • Optional name

    name?: null | string
    +
  • Defined in client/use-user.tsx:14

    • Optional nickname

    nickname?: null | string
    +
  • Defined in client/use-user.tsx:15

    • Optional org_id

    org_id?: null | string
    +
  • Defined in client/use-user.tsx:19

    • Optional picture

    picture?: null | string
    +
  • Defined in client/use-user.tsx:16

    • Optional sub

    sub?: null | string
    +
  • Defined in client/use-user.tsx:17

    • Optional updated_at

    updated_at?: null | string
    +
  • Defined in client/use-user.tsx:18
    • diff --git a/docs/interfaces/client_with_page_auth_required.UserProps.html b/docs/interfaces/client_with_page_auth_required.UserProps.html index 481a4bdfd..bbb60a625 100644 --- a/docs/interfaces/client_with_page_auth_required.UserProps.html +++ b/docs/interfaces/client_with_page_auth_required.UserProps.html @@ -21,7 +21,7 @@

    Hierarchy

    • UserProps
    +
  • Defined in client/with-page-auth-required.tsx:62
    • @@ -37,7 +37,7 @@

    Properties

    user

    user: UserProfile
    +
  • Defined in client/with-page-auth-required.tsx:63
    • diff --git a/docs/interfaces/client_with_page_auth_required.WithPageAuthRequiredOptions.html b/docs/interfaces/client_with_page_auth_required.WithPageAuthRequiredOptions.html index cbbfac497..a3d15fd16 100644 --- a/docs/interfaces/client_with_page_auth_required.WithPageAuthRequiredOptions.html +++ b/docs/interfaces/client_with_page_auth_required.WithPageAuthRequiredOptions.html @@ -24,7 +24,7 @@

    Hierarchy

    • WithPageAuthRequiredOptions
    +
  • Defined in client/with-page-auth-required.tsx:22
    • @@ -49,7 +49,7 @@

    Type declaration

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

    @@ -59,7 +59,7 @@

    Parameters

    error: Error

    • Returns Element

    +
  • Defined in client/with-page-auth-required.tsx:52

    • Optional onRedirecting

    onRedirecting?: (() => Element)
    @@ -71,21 +71,21 @@

    Type declaration

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

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

    Returns Element

    • +
  • Defined in client/with-page-auth-required.tsx:42

    • Optional returnTo

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

    Add a path to return the user to after login.

    +
  • Defined in client/with-page-auth-required.tsx:32
    • diff --git a/docs/interfaces/config.AuthorizationParameters.html b/docs/interfaces/config.AuthorizationParameters.html index 14458f62e..8ea717243 100644 --- a/docs/interfaces/config.AuthorizationParameters.html +++ b/docs/interfaces/config.AuthorizationParameters.html @@ -27,7 +27,7 @@

    Hierarchy

    • AuthorizationParameters
    +
  • Defined in config.ts:330
    • @@ -46,13 +46,13 @@

    response_moderesponse_mode: "query" | "form_post"

    +
  • Defined in config.ts:338

    • response_type

    response_type: "id_token" | "code id_token" | "code"
    +
  • Defined in config.ts:339

    • scope

    scope: string
    @@ -62,7 +62,7 @@

    scope

    Overrides OidcAuthorizationParameters.scope

    +
  • Defined in config.ts:336
    • diff --git a/docs/interfaces/config.BaseConfig.html b/docs/interfaces/config.BaseConfig.html index 1fe4369c3..5351b1f6a 100644 --- a/docs/interfaces/config.BaseConfig.html +++ b/docs/interfaces/config.BaseConfig.html @@ -21,7 +21,7 @@

    Hierarchy

    • BaseConfig
    +
  • Defined in config.ts:11
    • @@ -60,22 +60,22 @@

    OptionalAUTH0_LOGOUT environment variable.

    +
  • Defined in config.ts:32

    • authorizationParams

    authorizationParams: AuthorizationParameters

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

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

    {
      response_type: 'code',
      scope: 'openid profile email'
    }
-
    +

    New values can be passed in to change what is returned from the authorization server depending on your specific scenario. Additional custom parameters can be added as well.

    Note: You must provide the required parameters if this object is set.

    {
      response_type: 'code',
      scope: 'openid profile email',

      // Additional parameters
      acr_value: 'tenant:test-tenant',
      custom_param: 'custom-value'
    };
-
    +
    +
  • Defined in config.ts:62

    • baseURL

    baseURL: string
    @@ -83,9 +83,10 @@

    baseURL

    +
  • Defined in config.ts:72

    • Optional clientAssertionSigningAlg

    clientAssertionSigningAlg?: string
    @@ -96,7 +97,7 @@

    OptionalAUTH0_CLIENT_ASSERTION_SIGNING_ALG environment variable.

    +
  • Defined in config.ts:194

    • Optional clientAssertionSigningKey

    clientAssertionSigningKey?: string
    @@ -105,7 +106,7 @@

    OptionalAUTH0_CLIENT_ASSERTION_SIGNING_KEY environment variable.

    +
  • Defined in config.ts:185

    • clientID

    clientID: string
    @@ -113,7 +114,7 @@

    clientIDAUTH0_CLIENT_ID environment variable.

    +
  • Defined in config.ts:78

    • Optional clientSecret

    clientSecret?: string
    @@ -122,14 +123,14 @@

    OptionalAUTH0_CLIENT_SECRET environment variable.

    +
  • Defined in config.ts:85

    • clockTolerance

    clockTolerance: number

    Integer value for the system clock's tolerance (leeway) in seconds for ID token verification.Defaults to60seconds. You can also use theAUTH0_CLOCK_TOLERANCE` environment variable.

    +
  • Defined in config.ts:92

    • enableTelemetry

    enableTelemetry: boolean
    @@ -138,7 +139,7 @@

    enableTelemetry

    +
  • Defined in config.ts:106

    • getLoginState

    getLoginState: ((req, options) => Record<string, any>)
    @@ -153,7 +154,7 @@

    Type declaration

    Used for passing custom state parameters to your authorization server. Can also be passed in to HandleLogin.

    {
      ...
      getLoginState(req, options) {
        return {
          returnTo: options.returnTo || req.originalUrl,
          customState: 'foo'
        };
      }
    }
-
    +

    Parameters

    @@ -164,7 +165,7 @@
    req: options: LoginOptions

    Returns Record<string, any>

    +
  • Defined in config.ts:125

    • httpTimeout

    httpTimeout: number
    @@ -173,7 +174,7 @@

    httpTimeoutAUTH0_HTTP_TIMEOUT environment variable.

    +
  • Defined in config.ts:99

    • idTokenSigningAlg

    idTokenSigningAlg: string
    @@ -181,7 +182,7 @@

    idTokenSigningAlgAUTH0_ID_TOKEN_SIGNING_ALG environment variable.

    +
  • Defined in config.ts:144

    • identityClaimFilter

    identityClaimFilter: string[]
    @@ -190,7 +191,7 @@

    identityClaimFilterAUTH0_IDENTITY_CLAIM_FILTER environment variable.

    +
  • Defined in config.ts:132

    • idpLogout

    idpLogout: boolean
    @@ -198,7 +199,7 @@

    idpLogoutAUTH0_IDP_LOGOUT environment variable.

    +
  • Defined in config.ts:138

    • issuerBaseURL

    issuerBaseURL: string
    @@ -207,7 +208,7 @@

    issuerBaseURL

    +
  • Defined in config.ts:151

    • legacySameSiteCookie

    legacySameSiteCookie: boolean
    @@ -216,7 +217,7 @@

    legacySameSiteCookie< You can also use the AUTH0_LEGACY_SAME_SITE_COOKIE environment variable.

    +
  • Defined in config.ts:158

    • routes

    routes: {
        callback: string;
        postLogoutRedirect: string;
    }
    @@ -239,7 +240,7 @@
    postLogoutRedirectAUTH0_POST_LOGOUT_REDIRECT environment variable.

    +
  • Defined in config.ts:163

    • secret

    secret: string | string[]
    @@ -250,14 +251,14 @@

    secret

    +
  • Defined in config.ts:19

    • session

    session: SessionConfig

    Object defining application session cookie attributes.

    +
  • Defined in config.ts:24
    • diff --git a/docs/interfaces/config.CookieConfig.html b/docs/interfaces/config.CookieConfig.html index b298d5ad7..48779a814 100644 --- a/docs/interfaces/config.CookieConfig.html +++ b/docs/interfaces/config.CookieConfig.html @@ -24,7 +24,7 @@

    Hierarchy

    • CookieConfig
    +
  • Defined in config.ts:279
    • @@ -48,7 +48,7 @@

    OptionalAUTH0_COOKIE_DOMAIN environment variable.

    +
  • Defined in config.ts:284

    • httpOnly

    httpOnly: boolean
    @@ -57,7 +57,7 @@

    httpOnlyAUTH0_COOKIE_HTTP_ONLY environment variable.

    +
  • Defined in config.ts:306

    • Optional path

    path?: string
    @@ -67,7 +67,7 @@

    OptionalAUTH0_COOKIE_PATH environment variable.

    +
  • Defined in config.ts:292

    • sameSite

    sameSite: "lax" | "strict" | "none"
    @@ -76,7 +76,7 @@

    sameSiteAUTH0_COOKIE_SAME_SITE environment variable.

    +
  • Defined in config.ts:320

    • Optional secure

    secure?: boolean
    @@ -85,7 +85,7 @@

    OptionalAUTH0_COOKIE_SECURE environment variable.

    +
  • Defined in config.ts:313

    • transient

    transient: boolean
    @@ -94,7 +94,7 @@

    transientAUTH0_COOKIE_TRANSIENT environment variable.

    +
  • Defined in config.ts:299
    • diff --git a/docs/interfaces/config.NextConfig.html b/docs/interfaces/config.NextConfig.html index 37f1efa94..c62b9fc89 100644 --- a/docs/interfaces/config.NextConfig.html +++ b/docs/interfaces/config.NextConfig.html @@ -23,7 +23,7 @@

    Hierarchy

    • NextConfig
    +
  • Defined in config.ts:345
    • @@ -47,7 +47,7 @@

    identityClaimFilter

    +
  • Defined in config.ts:132

    • Optional organization

    organization?: string
    @@ -57,7 +57,7 @@

    OptionalIf your app supports multiple organizations, you should take a look at AuthorizationParams.organization.

    +
  • Defined in config.ts:354

    • routes

    routes: {
        callback: string;
        login: string;
        unauthorized: string;
    }
    @@ -71,12 +71,12 @@
    login
    unauthorized: string
    +
  • Defined in config.ts:355

    • session

    session: Pick<SessionConfig, "storeIDToken">
    +
  • Defined in config.ts:360
    • diff --git a/docs/interfaces/config.SessionConfig.html b/docs/interfaces/config.SessionConfig.html index b7d4be415..389e58171 100644 --- a/docs/interfaces/config.SessionConfig.html +++ b/docs/interfaces/config.SessionConfig.html @@ -24,7 +24,7 @@

    Hierarchy

    • SessionConfig
    +
  • Defined in config.ts:202
    • @@ -54,7 +54,7 @@

    absoluteDuration

    +
  • Defined in config.ts:254

    • Optional autoSave

    autoSave?: boolean
    @@ -64,12 +64,12 @@

    OptionalAUTH0_SESSION_AUTO_SAVE environment variable.

    +
  • Defined in config.ts:262

    • cookie

    cookie: CookieConfig
    +
  • Defined in config.ts:271

    • Optional genId

    genId?: (<Req, SessionType>(req, session) => string | Promise<string>)
    @@ -84,9 +84,9 @@

    Type declaration

    IMPORTANT If you override this, you must use a suitable value from your platform to prevent collisions. For example, for Node: require('crypto').randomBytes(16).toString('hex').

    -
    +

    Type Parameters

    -
      +

      • Req = any

      • @@ -100,7 +100,7 @@
        req: session: SessionType

    Returns string | Promise<string>

    +
  • Defined in config.ts:223

    • name

    name: string
    @@ -110,7 +110,7 @@

    name

    +
  • Defined in config.ts:209

    • rolling

    rolling: boolean
    @@ -122,7 +122,7 @@

    rolling

    +
  • Defined in config.ts:236

    • rollingDuration

    rollingDuration: number | false
    @@ -133,7 +133,7 @@

    rollingDuration

    +
  • Defined in config.ts:245

    • Optional store

    store?: SessionStore<default>
    @@ -141,7 +141,7 @@

    Optionalget, set and destroy methods to store the session on the server.

    +
  • Defined in config.ts:215

    • storeIDToken

    storeIDToken: boolean
    @@ -150,7 +150,7 @@

    storeIDTokentrue.

    +
  • Defined in config.ts:269
    • diff --git a/docs/interfaces/handlers_callback.CallbackOptions.html b/docs/interfaces/handlers_callback.CallbackOptions.html index 010fbeba5..29807265d 100644 --- a/docs/interfaces/handlers_callback.CallbackOptions.html +++ b/docs/interfaces/handlers_callback.CallbackOptions.html @@ -26,7 +26,7 @@

    Hierarchy

    • CallbackOptions
    +
  • Defined in handlers/callback.ts:104
    • @@ -45,7 +45,7 @@

    Properties

    Optional afterCallback

    afterCallback?: AfterCallback
    +
  • Defined in handlers/callback.ts:105

    • Optional authorizationParams

    authorizationParams?: Partial<AuthorizationParameters>
    @@ -53,7 +53,7 @@

    Optional

    +
  • Defined in handlers/callback.ts:123

    • Optional organization

    organization?: string
    @@ -61,7 +61,7 @@

    Optional

    +
  • Defined in handlers/callback.ts:117

    • Optional redirectUri

    redirectUri?: string
    @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in handlers/callback.ts:111
    • diff --git a/docs/interfaces/handlers_login.AuthorizationParams.html b/docs/interfaces/handlers_login.AuthorizationParams.html index e454a1067..648e51720 100644 --- a/docs/interfaces/handlers_login.AuthorizationParams.html +++ b/docs/interfaces/handlers_login.AuthorizationParams.html @@ -26,7 +26,7 @@

    Hierarchy

    • AuthorizationParams
    +
  • Defined in handlers/login.ts:40
    • @@ -49,19 +49,19 @@

    Optional 
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: async (req, res) => {
        try {
          await handleLogin(req, res, {
            // Get the connection name from the Auth0 Dashboard
            authorizationParams: { connection: 'github' }
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    +
  • Defined in handlers/login.ts:63

    • Optional connection_scope

    connection_scope?: string

    Provider scopes for OAuth2/social connections, such as GitHub or Google.

    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: async (req, res) => {
        try {
          await handleLogin(req, res, {
            authorizationParams: {
              connection: 'github',
              connection_scope: 'public_repo read:user'
            }
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +
    +
  • Defined in handlers/login.ts:87

    • Optional invitation

    invitation?: string
    @@ -69,12 +69,12 @@

    OptionalTo create a link for your user's to accept an organization invite, read the invitation and organization query params and pass them to the authorization server to log the user in:

    // pages/api/invite.js
    import { handleLogin } from '@auth0/nextjs-auth0';

    export default async function invite(req, res) {
      try {
        const { invitation, organization } = req.query;
        if (!invitation) {
          res.status(400).end('Missing "invitation" parameter');
        }
        await handleLogin(req, res, {
          authorizationParams: {
            invitation,
            organization
          }
        });
      } catch (error) {
        res.status(error.status || 500).end();
      }
    } ;
-
    +

    Your invite url can then take the format: https://example.com/api/invite?invitation=invitation_id&organization=org_id.

    +
  • Defined in handlers/login.ts:120

    • Optional organization

    organization?: string
    @@ -82,7 +82,7 @@

    Optional

    +
  • Defined in handlers/login.ts:126

    • Optional screen_hint

    screen_hint?: string
    @@ -91,7 +91,7 @@

    OptionalThis only affects the New Universal Login Experience.

    +
  • Defined in handlers/login.ts:134
    • diff --git a/docs/interfaces/handlers_login.LoginOptions.html b/docs/interfaces/handlers_login.LoginOptions.html index fd1e9815f..5ed133d93 100644 --- a/docs/interfaces/handlers_login.LoginOptions.html +++ b/docs/interfaces/handlers_login.LoginOptions.html @@ -26,7 +26,7 @@

    Hierarchy

    • LoginOptions
    +
  • Defined in handlers/login.ts:144
    • @@ -46,21 +46,21 @@

    Optional

    Override the default authorizationParams.

    +
  • Defined in handlers/login.ts:148

    • Optional getLoginState

    getLoginState?: GetLoginState

    Generate a unique state value for use during login transactions.

    +
  • Defined in handlers/login.ts:158

    • Optional returnTo

    returnTo?: string

    URL to return to after login. Overrides the default in baseURL.

    +
  • Defined in handlers/login.ts:153
    • diff --git a/docs/interfaces/handlers_logout.LogoutOptions.html b/docs/interfaces/handlers_logout.LogoutOptions.html index 9d6be1b4e..37bc7e20e 100644 --- a/docs/interfaces/handlers_logout.LogoutOptions.html +++ b/docs/interfaces/handlers_logout.LogoutOptions.html @@ -26,7 +26,7 @@

    Hierarchy

    • LogoutOptions
    +
  • Defined in handlers/logout.ts:14
    • @@ -50,7 +50,7 @@

    Type declaration

  • [key: string]: any
    • +
  • Defined in handlers/logout.ts:24

    • Optional returnTo

    returnTo?: string
    @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in handlers/logout.ts:19
    • diff --git a/docs/interfaces/index.Auth0Server.html b/docs/interfaces/index.Auth0Server.html index 53ae6aad6..da140dfa4 100644 --- a/docs/interfaces/index.Auth0Server.html +++ b/docs/interfaces/index.Auth0Server.html @@ -26,7 +26,7 @@

    Hierarchy

    • Auth0Server
    +
  • Defined in index.ts:74
    • @@ -54,77 +54,77 @@

    getAccessToken

    Access token getter.

    +
  • Defined in index.ts:93

    • getSession

    getSession: GetSession

    Session getter.

    +
  • Defined in index.ts:78

    • handleAuth

    handleAuth: HandleAuth

    Create the main handlers for your api routes.

    +
  • Defined in index.ts:128

    • handleCallback

    handleCallback: HandleCallback

    Callback handler which will complete the transaction and create a local session.

    +
  • Defined in index.ts:103

    • handleLogin

    handleLogin: HandleLogin

    Login handler which will redirect the user to Auth0.

    +
  • Defined in index.ts:98

    • handleLogout

    handleLogout: HandleLogout

    Logout handler which will clear the local session and the Auth0 session.

    +
  • Defined in index.ts:108

    • handleProfile

    handleProfile: HandleProfile

    Profile handler which return profile information about the user.

    +
  • Defined in index.ts:113

    • touchSession

    touchSession: TouchSession

    Update the expiry of a rolling session when autoSave is disabled.

    +
  • Defined in index.ts:83

    • updateSession

    updateSession: UpdateSession

    Append properties to the user.

    +
  • Defined in index.ts:88

    • withApiAuthRequired

    withApiAuthRequired: WithApiAuthRequired

    Helper that adds auth to an API route.

    +
  • Defined in index.ts:118

    • withPageAuthRequired

    withPageAuthRequired: WithPageAuthRequired

    Helper that adds auth to a Page route.

    +
  • Defined in index.ts:123
    • diff --git a/docs/interfaces/session_get_access_token.AccessTokenRequest.html b/docs/interfaces/session_get_access_token.AccessTokenRequest.html index 75189f113..6c6e49847 100644 --- a/docs/interfaces/session_get_access_token.AccessTokenRequest.html +++ b/docs/interfaces/session_get_access_token.AccessTokenRequest.html @@ -24,7 +24,7 @@

    Hierarchy

    • AccessTokenRequest
    +
  • Defined in session/get-access-token.ts:17
    • @@ -50,17 +50,17 @@

    See

    also the AfterRefetch hook.

    Example

    Modify the session after refresh

    // pages/api/my-handler.js
    import { getAccessToken } from '@auth0/nextjs-auth0';

    const afterRefresh = (req, res, session) => {
      session.user.customProperty = 'foo';
      delete session.idToken;
      return session;
    };

    export default async function MyHandler(req, res) {
      const accessToken = await getAccessToken(req, res, {
        refresh: true,
        afterRefresh,
      });
    };
-
    +
    +
  • Defined in session/get-access-token.ts:59

    • Optional authorizationParams

    authorizationParams?: Partial<AuthorizationParameters>

    This is useful for sending custom query parameters in the body of the refresh grant request for use in rules.

    +
  • Defined in session/get-access-token.ts:64

    • Optional refresh

    refresh?: boolean
    @@ -70,14 +70,14 @@

    Optional

    +
  • Defined in session/get-access-token.ts:30

    • Optional scopes

    scopes?: string[]

    A list of desired scopes for your access token.

    +
  • Defined in session/get-access-token.ts:21
    • diff --git a/docs/interfaces/session_get_access_token.GetAccessTokenResult.html b/docs/interfaces/session_get_access_token.GetAccessTokenResult.html index 5c7d3afac..7080d4edf 100644 --- a/docs/interfaces/session_get_access_token.GetAccessTokenResult.html +++ b/docs/interfaces/session_get_access_token.GetAccessTokenResult.html @@ -24,7 +24,7 @@

    Hierarchy

    • GetAccessTokenResult
    +
  • Defined in session/get-access-token.ts:72
    • @@ -42,7 +42,7 @@

    Optional

    Access token returned from the token cache.

    +
  • Defined in session/get-access-token.ts:76
    • diff --git a/docs/interfaces/session_session.Claims.html b/docs/interfaces/session_session.Claims.html index b9a0353d4..f42335cc6 100644 --- a/docs/interfaces/session_session.Claims.html +++ b/docs/interfaces/session_session.Claims.html @@ -27,7 +27,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in session/session.ts:10
    • diff --git a/docs/modules/client.html b/docs/modules/client.html index 489c9c110..caaa1eda4 100644 --- a/docs/modules/client.html +++ b/docs/modules/client.html @@ -16,9 +16,7 @@
  • client

    • Module client

    -
    -
    +
  • Defined in client/index.ts:1
    • diff --git a/docs/modules/client_use_user.html b/docs/modules/client_use_user.html index f7dcc8d52..16b180a49 100644 --- a/docs/modules/client_use_user.html +++ b/docs/modules/client_use_user.html @@ -16,9 +16,7 @@
  • client/use-user

    • Module client/use-user

    -
    -
    +
  • Defined in client/use-user.tsx:1

    • Index

    diff --git a/docs/modules/client_with_page_auth_required.html b/docs/modules/client_with_page_auth_required.html index c90ee1384..b58e86ad1 100644 --- a/docs/modules/client_with_page_auth_required.html +++ b/docs/modules/client_with_page_auth_required.html @@ -16,9 +16,7 @@
  • client/with-page-auth-required

    • Module client/with-page-auth-required

    -
    -
    +
  • Defined in client/with-page-auth-required.tsx:1

    • Index

    diff --git a/docs/modules/config.html b/docs/modules/config.html index c8567e00a..09ece4cc8 100644 --- a/docs/modules/config.html +++ b/docs/modules/config.html @@ -16,9 +16,7 @@
  • config

    • Module config

    -
    -
    +
  • Defined in config.ts:1

    • Index

    diff --git a/docs/modules/edge.html b/docs/modules/edge.html index 3b50c1dfc..591844c65 100644 --- a/docs/modules/edge.html +++ b/docs/modules/edge.html @@ -16,9 +16,7 @@
  • edge

    • Module edge

    -
    -
    +
  • Defined in edge.ts:1
    • diff --git a/docs/modules/handlers.html b/docs/modules/handlers.html index b42ab9097..2092a1966 100644 --- a/docs/modules/handlers.html +++ b/docs/modules/handlers.html @@ -16,9 +16,7 @@
  • handlers

    • Module handlers

    -
    -
    +
  • Defined in handlers/index.ts:1
    • diff --git a/docs/modules/handlers_auth.html b/docs/modules/handlers_auth.html index 224eade65..b2a1e7cb9 100644 --- a/docs/modules/handlers_auth.html +++ b/docs/modules/handlers_auth.html @@ -16,9 +16,7 @@
  • handlers/auth

    • Module handlers/auth

    -
    -
    +
  • Defined in handlers/auth.ts:1

    • Index

    diff --git a/docs/modules/handlers_callback.html b/docs/modules/handlers_callback.html index 2151ca866..e91b03cb0 100644 --- a/docs/modules/handlers_callback.html +++ b/docs/modules/handlers_callback.html @@ -16,9 +16,7 @@
  • handlers/callback

    • Module handlers/callback

    -
    -
    +
  • Defined in handlers/callback.ts:1

    • Index

    diff --git a/docs/modules/handlers_login.html b/docs/modules/handlers_login.html index 6129e0c2c..9a285f262 100644 --- a/docs/modules/handlers_login.html +++ b/docs/modules/handlers_login.html @@ -16,9 +16,7 @@
  • handlers/login

    • Module handlers/login

    -
    -
    +
  • Defined in handlers/login.ts:1

    • Index

    diff --git a/docs/modules/handlers_logout.html b/docs/modules/handlers_logout.html index 10aab600a..b7d9db025 100644 --- a/docs/modules/handlers_logout.html +++ b/docs/modules/handlers_logout.html @@ -16,9 +16,7 @@
  • handlers/logout

    • Module handlers/logout

    -
    -
    +
  • Defined in handlers/logout.ts:1

    • Index

    diff --git a/docs/modules/handlers_profile.html b/docs/modules/handlers_profile.html index 73bfbaa33..b2039e138 100644 --- a/docs/modules/handlers_profile.html +++ b/docs/modules/handlers_profile.html @@ -16,9 +16,7 @@
  • handlers/profile

    • Module handlers/profile

    -
    -
    +
  • Defined in handlers/profile.ts:1

    • Index

    diff --git a/docs/modules/helpers.html b/docs/modules/helpers.html index e466f382d..ad034b6a9 100644 --- a/docs/modules/helpers.html +++ b/docs/modules/helpers.html @@ -16,9 +16,7 @@
  • helpers

    • Module helpers

    -
    -
    +
  • Defined in helpers/index.ts:1
    • diff --git a/docs/modules/helpers_testing.html b/docs/modules/helpers_testing.html index f52b2309c..1a7a1d1fa 100644 --- a/docs/modules/helpers_testing.html +++ b/docs/modules/helpers_testing.html @@ -16,9 +16,7 @@
  • helpers/testing

    • Module helpers/testing

    -
    -
    +
  • Defined in helpers/testing.ts:1

    • Index

    diff --git a/docs/modules/helpers_with_api_auth_required.html b/docs/modules/helpers_with_api_auth_required.html index ba2a67b16..d7383012b 100644 --- a/docs/modules/helpers_with_api_auth_required.html +++ b/docs/modules/helpers_with_api_auth_required.html @@ -16,9 +16,7 @@
  • helpers/with-api-auth-required

    • Module helpers/with-api-auth-required

    -
    -
    +
  • Defined in helpers/with-api-auth-required.ts:1

    • Index

    diff --git a/docs/modules/helpers_with_middleware_auth_required.html b/docs/modules/helpers_with_middleware_auth_required.html index af9b199b5..fec7ac71f 100644 --- a/docs/modules/helpers_with_middleware_auth_required.html +++ b/docs/modules/helpers_with_middleware_auth_required.html @@ -16,9 +16,7 @@
  • helpers/with-middleware-auth-required

    • Module helpers/with-middleware-auth-required

    -
    -
    +
  • Defined in helpers/with-middleware-auth-required.ts:1

    • Index

    diff --git a/docs/modules/helpers_with_page_auth_required.html b/docs/modules/helpers_with_page_auth_required.html index 8bf4aca80..7536c7876 100644 --- a/docs/modules/helpers_with_page_auth_required.html +++ b/docs/modules/helpers_with_page_auth_required.html @@ -16,9 +16,7 @@
  • helpers/with-page-auth-required

    • Module helpers/with-page-auth-required

    -
    -
    +
  • Defined in helpers/with-page-auth-required.ts:1

    • Index

    diff --git a/docs/modules/index.html b/docs/modules/index.html index c75479b07..6d89ddc0d 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -16,9 +16,7 @@
  • index

    • Module index

    -
    -
    +
  • Defined in index.ts:1
    • diff --git a/docs/modules/session.html b/docs/modules/session.html index 7bdfbc041..ed4e41211 100644 --- a/docs/modules/session.html +++ b/docs/modules/session.html @@ -16,9 +16,7 @@
  • session

    • Module session

    -
    -
    +
  • Defined in session/index.ts:1
    • diff --git a/docs/modules/session_get_access_token.html b/docs/modules/session_get_access_token.html index 96ce27399..47e63c79c 100644 --- a/docs/modules/session_get_access_token.html +++ b/docs/modules/session_get_access_token.html @@ -16,9 +16,7 @@
  • session/get-access-token

    • Module session/get-access-token

    -
    -
    +
  • Defined in session/get-access-token.ts:1

    • Index

    diff --git a/docs/modules/session_get_session.html b/docs/modules/session_get_session.html index 4ba511a82..2190740e6 100644 --- a/docs/modules/session_get_session.html +++ b/docs/modules/session_get_session.html @@ -16,9 +16,7 @@
  • session/get-session

    • Module session/get-session

    -
    -
    +
  • Defined in session/get-session.ts:1

    • Index

    diff --git a/docs/modules/session_session.html b/docs/modules/session_session.html index a945bddab..6aeddae62 100644 --- a/docs/modules/session_session.html +++ b/docs/modules/session_session.html @@ -16,9 +16,7 @@
  • session/session

    • Module session/session

    -
    -
    +
  • Defined in session/session.ts:1

    • Index

    diff --git a/docs/modules/session_touch_session.html b/docs/modules/session_touch_session.html index bd5ee0c6b..d914ffbf7 100644 --- a/docs/modules/session_touch_session.html +++ b/docs/modules/session_touch_session.html @@ -16,9 +16,7 @@
  • session/touch-session

    • Module session/touch-session

    -
    -
    +
  • Defined in session/touch-session.ts:1

    • Index

    diff --git a/docs/modules/session_update_session.html b/docs/modules/session_update_session.html index 396b8d53b..ac54d88a2 100644 --- a/docs/modules/session_update_session.html +++ b/docs/modules/session_update_session.html @@ -16,9 +16,7 @@
  • session/update-session

    • Module session/update-session

    -
    -
    +
  • Defined in session/update-session.ts:1

    • Index

    diff --git a/docs/modules/utils_errors.html b/docs/modules/utils_errors.html index ff65e0c67..e0e2624be 100644 --- a/docs/modules/utils_errors.html +++ b/docs/modules/utils_errors.html @@ -16,9 +16,7 @@
  • utils/errors

    • Module utils/errors

    -
    -
    +
  • Defined in utils/errors.ts:1

    • Index

    diff --git a/docs/modules/version.html b/docs/modules/version.html index b5042b513..ac741c0e7 100644 --- a/docs/modules/version.html +++ b/docs/modules/version.html @@ -16,9 +16,7 @@
  • version

    • Module version

    -
    -
    +
  • Defined in version.ts:1

    • Index

    diff --git a/docs/types/client_use_user.UserContext.html b/docs/types/client_use_user.UserContext.html index e5c456a2c..7ca020397 100644 --- a/docs/types/client_use_user.UserContext.html +++ b/docs/types/client_use_user.UserContext.html @@ -37,8 +37,8 @@
    isLoading
    Optional user?: UserProfile
    +
  • Defined in client/use-user.tsx:28
    • +
  • Defined in client/use-user.tsx:116
    • diff --git a/docs/types/client_use_user.UserProvider.html b/docs/types/client_use_user.UserProvider.html index 8ec16ad8c..9445ce6bc 100644 --- a/docs/types/client_use_user.UserProvider.html +++ b/docs/types/client_use_user.UserProvider.html @@ -33,7 +33,7 @@

    Parameters

    props: UserProviderProps

    Returns ReactElement<UserContext>

    +
  • Defined in client/use-user.tsx:164
    • diff --git a/docs/types/client_use_user.UserProviderProps.html b/docs/types/client_use_user.UserProviderProps.html index 8d26d3b24..0967a625f 100644 --- a/docs/types/client_use_user.UserProviderProps.html +++ b/docs/types/client_use_user.UserProviderProps.html @@ -23,7 +23,7 @@

    Type alias UserProviderProps

    prop. This will prefill the useUser hook with the UserProfile object. For example:

    // pages/_app.js
    import React from 'react';
    import { UserProvider } from '@auth0/nextjs-auth0/client';

    export default function App({ Component, pageProps }) {
      // If you've used `withPageAuthRequired`, `pageProps.user` can prefill the hook
      // if you haven't used `withPageAuthRequired`, `pageProps.user` is undefined so the hook
      // fetches the user from the API route
      const { user } = pageProps;

      return (
        <UserProvider user={user}>
          <Component {...pageProps} />
        </UserProvider>
      );
    }
-
    +

    In client-side rendered pages, the useUser hook uses a UserFetcher to fetch the user from the profile API route. If needed, you can specify a custom fetcher here in the fetcher option.

    @@ -31,7 +31,7 @@

    Type alias UserProviderProps

    (the default is /api/auth/me) then you need to specify it here in the profileUrl option.

    +
  • Defined in client/use-user.tsx:104
    • diff --git a/docs/types/client_with_page_auth_required.WithPageAuthRequired.html b/docs/types/client_with_page_auth_required.WithPageAuthRequired.html index 5028ae342..7d76036e6 100644 --- a/docs/types/client_with_page_auth_required.WithPageAuthRequired.html +++ b/docs/types/client_with_page_auth_required.WithPageAuthRequired.html @@ -25,13 +25,13 @@

    Type declaration

  • <P>(Component, options?): 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 Parameters

    -
      +

      • P extends WithPageAuthRequiredProps

    @@ -43,7 +43,7 @@
    Component: Optional options: WithPageAuthRequiredOptions

    • Returns React.FC<P>

    +
  • Defined in client/with-page-auth-required.tsx:76
    • diff --git a/docs/types/config.ConfigParameters.html b/docs/types/config.ConfigParameters.html index d3600dabd..b7f59730a 100644 --- a/docs/types/config.ConfigParameters.html +++ b/docs/types/config.ConfigParameters.html @@ -17,22 +17,22 @@
  • ConfigParameters

    • Type alias ConfigParameters

    ConfigParameters: DeepPartial<BaseConfig & NextConfig>
    -

    Configuration properties.

    The Server part of the SDK can be configured in 2 ways.

    -

    1. Environment Variables

    The simplest way to use the SDK is to use the named exports (HandleAuth, HandleLogin, +

    Configuration properties.

    The Server part of the SDK can be configured in 2 ways.

    +

    1. Environment Variables

    The simplest way to use the SDK is to use the named exports (HandleAuth, HandleLogin, HandleLogout, HandleCallback, HandleProfile, GetSession, GetAccessToken, WithApiAuthRequired, and WithPageAuthRequired).

    // pages/api/auth/[...auth0].js
    import { handleAuth } from '@auth0/nextjs-auth0';

    return handleAuth();
-
    +

    When you use these named exports, an instance of the SDK is created for you which you can configure using environment variables:

    -

    Required

      +

      Required

      • AUTH0_SECRET: See secret.
      • AUTH0_ISSUER_BASE_URL: See issuerBaseURL.
      • AUTH0_BASE_URL: See baseURL.
      • AUTH0_CLIENT_ID: See clientID.
      • AUTH0_CLIENT_SECRET: See clientSecret.
      -

      Optional

        +

        Optional

        • AUTH0_CLOCK_TOLERANCE: See clockTolerance.
        • AUTH0_HTTP_TIMEOUT: See httpTimeout.
        • AUTH0_ENABLE_TELEMETRY: See enableTelemetry.
          • @@ -60,21 +60,21 @@

          Type alias ConfigParameters

  • AUTH0_CLIENT_ASSERTION_SIGNING_KEY: See clientAssertionSigningKey
  • AUTH0_CLIENT_ASSERTION_SIGNING_ALG: See clientAssertionSigningAlg
    • -

    2. Create your own instance using InitAuth0

    If you don't want to configure the SDK with environment variables or you want more fine grained control over the +

    2. Create your own instance using InitAuth0

    If you don't want to configure the SDK with environment variables or you want more fine grained control over the instance, you can create an instance yourself and use the handlers and helpers from that.

    First, export your configured instance from another module:

    // utils/auth0.js
    import { initAuth0 } from '@auth0/nextjs-auth0';

    export default initAuth0({ ...ConfigParameters... });
-
    +

    Then import it into your route handler:

    // pages/api/auth/[...auth0].js
    import auth0 from '../../../../utils/auth0';

    return auth0.handleAuth();
-
    +

    IMPORTANT If you use InitAuth0, you should not use the other named exports as they will use a different instance of the SDK. Also note - this is for the server side part of the SDK - you will always use named exports for the front end components: {@Link UserProvider}, {@Link UseUser} and the front end version of {@Link WithPageAuthRequired}

    +
  • Defined in config.ts:451
    • diff --git a/docs/types/edge.Auth0Edge.html b/docs/types/edge.Auth0Edge.html index 04c384a29..16bcb968e 100644 --- a/docs/types/edge.Auth0Edge.html +++ b/docs/types/edge.Auth0Edge.html @@ -25,7 +25,7 @@
    getSession
    withMiddlewareAuthRequired: WithMiddlewareAuthRequired
    +
  • Defined in edge.ts:14
    • diff --git a/docs/types/edge.GetSession.html b/docs/types/edge.GetSession.html index 3a06b1c27..848bf4189 100644 --- a/docs/types/edge.GetSession.html +++ b/docs/types/edge.GetSession.html @@ -33,7 +33,7 @@
    req: res: NextResponse

    Returns Promise<default | null | undefined>

    +
  • Defined in edge.ts:16
    • diff --git a/docs/types/edge.InitAuth0.html b/docs/types/edge.InitAuth0.html index 824ee5cb2..8ee0dd952 100644 --- a/docs/types/edge.InitAuth0.html +++ b/docs/types/edge.InitAuth0.html @@ -31,7 +31,7 @@

    Parameters

    Optional params: ConfigParameters

    Returns Auth0Edge

    +
  • Defined in edge.ts:18
    • diff --git a/docs/types/handlers_auth.HandleAuth.html b/docs/types/handlers_auth.HandleAuth.html index 7645d78c1..7878cf97f 100644 --- a/docs/types/handlers_auth.HandleAuth.html +++ b/docs/types/handlers_auth.HandleAuth.html @@ -28,7 +28,7 @@

    Type declaration

    Simply set the environment variables per ConfigParameters then create the file pages/api/auth/[...auth0].js. For example:

    // pages/api/auth/[...auth0].js
    import { handleAuth } from '@auth0/nextjs-auth0';

    export default handleAuth();
-
    +

    This will create 5 handlers for the following urls:

    • /api/auth/login: log the user in to your app by redirecting them to your identity provider.
      • @@ -45,7 +45,7 @@

      Parameters

      Optional userHandlers: Handlers

    Returns NextApiHandler

    +
  • Defined in handlers/auth.ts:94
    • diff --git a/docs/types/handlers_auth.Handlers.html b/docs/types/handlers_auth.Handlers.html index 95dd22c82..39cfb92ec 100644 --- a/docs/types/handlers_auth.Handlers.html +++ b/docs/types/handlers_auth.Handlers.html @@ -20,16 +20,16 @@

    Type alias Handlers

    If you want to add some custom behavior to the default auth handlers, you can pass in custom handlers for login, logout, callback, and profile. For example:

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';
    import { errorReporter, logger } from '../../../utils';

    export default handleAuth({
      async login(req, res) {
        try {
           // Pass in custom params to your handler
          await handleLogin(req, res, { authorizationParams: { customParam: 'foo' } });
          // Add your own custom logging.
          logger('Redirecting to login');
        } catch (error) {
          // Add you own custom error logging.
          errorReporter(error);
          res.status(error.status || 500).end();
        }
      }
    });
-
    +

    Alternatively, you can customize the default handlers without overriding them. For example:

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: handleLogin({
        authorizationParams: { customParam: 'foo' } // Pass in custom params
      })
    });
-
    +

    You can also create new handlers by customizing the default ones. For example:

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      signup: handleLogin({
        authorizationParams: { screen_hint: 'signup' }
      })
    });
-
    +
    +
  • Defined in handlers/auth.ts:61
    • diff --git a/docs/types/handlers_auth.OnError.html b/docs/types/handlers_auth.OnError.html index 6fcb54711..f80e22ed2 100644 --- a/docs/types/handlers_auth.OnError.html +++ b/docs/types/handlers_auth.OnError.html @@ -27,7 +27,7 @@

    Type declaration

    Error handler for the default auth routes.

    Use this to define an error handler for all the default routes in a single place. For example:

    export default handleAuth({
      onError(req, res, error) {
        errorLogger(error);
        // You can finish the response yourself if you want to customize
        // the status code or redirect the user
        // res.writeHead(302, {
        //     Location: '/custom-error-page'
        // });
        // res.end();
      }
    });
-
    +

    Parameters

    @@ -40,7 +40,7 @@
    res: error: HandlerError

    Returns Promise<void> | void

    +
  • Defined in handlers/auth.ts:117
    • diff --git a/docs/types/handlers_callback.AfterCallback.html b/docs/types/handlers_callback.AfterCallback.html index c66f0a351..c41b671bb 100644 --- a/docs/types/handlers_callback.AfterCallback.html +++ b/docs/types/handlers_callback.AfterCallback.html @@ -29,15 +29,15 @@

    Type declaration

    Example

    Validate additional claims

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    const afterCallback = (req, res, session, state) => {
      if (session.user.isAdmin) {
        return session;
      } else {
        res.status(401).end('User is not admin');
      }
    };

    export default handleAuth({
      async callback(req, res) {
        try {
          await handleCallback(req, res, { afterCallback });
        } catch (error) {
          res.status(error.status || 500).end();
        }
      }
    });
-
    +

    Example

    Modify the session after login

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    const afterCallback = (req, res, session, state) => {
      session.user.customProperty = 'foo';
      delete session.refreshToken;
      return session;
    };

    export default handleAuth({
      async callback(req, res) {
        try {
          await handleCallback(req, res, { afterCallback });
        } catch (error) {
          res.status(error.status || 500).end();
        }
      }
    });
-
    +

    Example

    Redirect successful login based on claim

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    const afterCallback = (req, res, session, state) => {
      if (!session.user.isAdmin) {
        res.setHeader('Location', '/admin');
      }
      return session;
    };

    export default handleAuth({
      async callback(req, res) {
        try {
          await handleCallback(req, res, { afterCallback });
        } catch (error) {
          res.status(error.status || 500).end(error.message);
        }
      }
    });
-
    +

    Throws

    HandlerError

    @@ -57,7 +57,7 @@
    Optional [key: string]: any

    Returns Promise<default | undefined> | default | undefined

    +
  • Defined in handlers/callback.ts:90
    • diff --git a/docs/types/handlers_callback.CallbackHandler.html b/docs/types/handlers_callback.CallbackHandler.html index 9bc75deb0..55d72bad5 100644 --- a/docs/types/handlers_callback.CallbackHandler.html +++ b/docs/types/handlers_callback.CallbackHandler.html @@ -39,7 +39,7 @@
    res: Optional options: CallbackOptions

    Returns Promise<void>

    +
  • Defined in handlers/callback.ts:197
    • diff --git a/docs/types/handlers_callback.CallbackOptionsProvider.html b/docs/types/handlers_callback.CallbackOptionsProvider.html index 45cd60666..f6ae95e4b 100644 --- a/docs/types/handlers_callback.CallbackOptionsProvider.html +++ b/docs/types/handlers_callback.CallbackOptionsProvider.html @@ -34,7 +34,7 @@

    Parameters

    req: NextApiRequest

    Returns CallbackOptions

    +
  • Defined in handlers/callback.ts:132
    • diff --git a/docs/types/handlers_callback.HandleCallback.html b/docs/types/handlers_callback.HandleCallback.html index a86f48402..b057edad7 100644 --- a/docs/types/handlers_callback.HandleCallback.html +++ b/docs/types/handlers_callback.HandleCallback.html @@ -29,16 +29,16 @@

    Type declaration

    Example

    Pass an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    export default handleAuth({
      callback: handleCallback({ redirectUri: 'https://example.com' })
    });
-
    +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    export default handleAuth({
      callback: handleCallback((req) => {
        return { redirectUri: 'https://example.com' };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the callback handler

    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    export default handleAuth({
      callback: async (req, res) => {
        try {
          await handleCallback(req, res, {
            redirectUri: 'https://example.com'
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -57,16 +57,16 @@

    Returns Promise<

    Example

    Pass an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    export default handleAuth({
      callback: handleCallback({ redirectUri: 'https://example.com' })
    });
-
    +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    export default handleAuth({
      callback: handleCallback((req) => {
        return { redirectUri: 'https://example.com' };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the callback handler

    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    export default handleAuth({
      callback: async (req, res) => {
        try {
          await handleCallback(req, res, {
            redirectUri: 'https://example.com'
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -81,16 +81,16 @@

    Returns // pages/api/auth/[...auth0].js
    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    export default handleAuth({
    callback: handleCallback({ redirectUri: 'https://example.com' })
    }); - +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    export default handleAuth({
      callback: handleCallback((req) => {
        return { redirectUri: 'https://example.com' };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the callback handler

    import { handleAuth, handleCallback } from '@auth0/nextjs-auth0';

    export default handleAuth({
      callback: async (req, res) => {
        try {
          await handleCallback(req, res, {
            redirectUri: 'https://example.com'
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -99,7 +99,7 @@

    Parameters

    options: CallbackOptions

    Returns CallbackHandler

    +
  • Defined in handlers/callback.ts:184
    • diff --git a/docs/types/handlers_login.GetLoginState.html b/docs/types/handlers_login.GetLoginState.html index be5ef5c8b..38090607d 100644 --- a/docs/types/handlers_login.GetLoginState.html +++ b/docs/types/handlers_login.GetLoginState.html @@ -26,7 +26,7 @@

    Type declaration

  • Use this to store additional state for the user before they visit the identity provider to log in.

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    const getLoginState = (req, loginOptions) => {
      return { basket_id: getBasketId(req) };
    };

    export default handleAuth({
      async login(req, res) {
        try {
          await handleLogin(req, res, { getLoginState });
        } catch (error) {
          res.status(error.status || 500).end();
        }
      }
    });
-
    +

    Parameters

    @@ -40,7 +40,7 @@

    Returns {
    [key: string]: any

    • +
  • Defined in handlers/login.ts:33
    • diff --git a/docs/types/handlers_login.HandleLogin.html b/docs/types/handlers_login.HandleLogin.html index 7cc67b17a..8915ce238 100644 --- a/docs/types/handlers_login.HandleLogin.html +++ b/docs/types/handlers_login.HandleLogin.html @@ -29,16 +29,16 @@

    Type declaration

    Example

    Pass an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: handleLogin({
        authorizationParams: { connection: 'github' }
      })
    });
-
    +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: handleLogin((req) => {
        return {
          authorizationParams: { connection: 'github' }
        };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the login handler

    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: async (req, res) => {
        try {
          await handleLogin(req, res, {
            authorizationParams: { connection: 'github' }
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -57,16 +57,16 @@

    Returns Promise<

    Example

    Pass an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: handleLogin({
        authorizationParams: { connection: 'github' }
      })
    });
-
    +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: handleLogin((req) => {
        return {
          authorizationParams: { connection: 'github' }
        };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the login handler

    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: async (req, res) => {
        try {
          await handleLogin(req, res, {
            authorizationParams: { connection: 'github' }
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -81,16 +81,16 @@

    Returns Example

    Pass an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: handleLogin({
        authorizationParams: { connection: 'github' }
      })
    });
-
    +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: handleLogin((req) => {
        return {
          authorizationParams: { connection: 'github' }
        };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the login handler

    import { handleAuth, handleLogin } from '@auth0/nextjs-auth0';

    export default handleAuth({
      login: async (req, res) => {
        try {
          await handleLogin(req, res, {
            authorizationParams: { connection: 'github' }
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -99,7 +99,7 @@

    Parameters

    options: LoginOptions

    Returns LoginHandler

    +
  • Defined in handlers/login.ts:223
    • diff --git a/docs/types/handlers_login.LoginHandler.html b/docs/types/handlers_login.LoginHandler.html index d104b1653..664323a99 100644 --- a/docs/types/handlers_login.LoginHandler.html +++ b/docs/types/handlers_login.LoginHandler.html @@ -39,7 +39,7 @@
    res: Optional options: LoginOptions

    Returns Promise<void>

    +
  • Defined in handlers/login.ts:236
    • diff --git a/docs/types/handlers_login.LoginOptionsProvider.html b/docs/types/handlers_login.LoginOptionsProvider.html index 12c17da73..41639b33f 100644 --- a/docs/types/handlers_login.LoginOptionsProvider.html +++ b/docs/types/handlers_login.LoginOptionsProvider.html @@ -34,7 +34,7 @@

    Parameters

    req: NextApiRequest

    Returns LoginOptions

    +
  • Defined in handlers/login.ts:167
    • diff --git a/docs/types/handlers_logout.HandleLogout.html b/docs/types/handlers_logout.HandleLogout.html index 8283fd0fc..3c1b4c23a 100644 --- a/docs/types/handlers_logout.HandleLogout.html +++ b/docs/types/handlers_logout.HandleLogout.html @@ -29,16 +29,16 @@

    Type declaration

    Example

    Pass an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

    export default handleAuth({
      logout: handleLogout({ returnTo: 'https://example.com' })
    });
-
    +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

    export default handleAuth({
      logout: handleLogout((req) => {
        return { returnTo: 'https://example.com' };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the logout handler

    import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

    export default handleAuth({
      logout: async (req, res) => {
        try {
          await handleLogout(req, res, {
            returnTo: 'https://example.com'
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -57,16 +57,16 @@

    Returns Promise<

    Example

    Pass an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

    export default handleAuth({
      logout: handleLogout({ returnTo: 'https://example.com' })
    });
-
    +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

    export default handleAuth({
      logout: handleLogout((req) => {
        return { returnTo: 'https://example.com' };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the logout handler

    import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

    export default handleAuth({
      logout: async (req, res) => {
        try {
          await handleLogout(req, res, {
            returnTo: 'https://example.com'
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -81,16 +81,16 @@

    Returns // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

    export default handleAuth({
    logout: handleLogout({ returnTo: 'https://example.com' })
    }); - +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

    export default handleAuth({
      logout: handleLogout((req) => {
        return { returnTo: 'https://example.com' };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the logout handler

    import { handleAuth, handleLogout } from '@auth0/nextjs-auth0';

    export default handleAuth({
      logout: async (req, res) => {
        try {
          await handleLogout(req, res, {
            returnTo: 'https://example.com'
          });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -99,7 +99,7 @@

    Parameters

    options: LogoutOptions

    Returns LogoutHandler

    +
  • Defined in handlers/logout.ts:85
    • diff --git a/docs/types/handlers_logout.LogoutHandler.html b/docs/types/handlers_logout.LogoutHandler.html index 8b295eb00..07f5a3501 100644 --- a/docs/types/handlers_logout.LogoutHandler.html +++ b/docs/types/handlers_logout.LogoutHandler.html @@ -39,7 +39,7 @@
    res: Optional options: LogoutOptions

    Returns Promise<void>

    +
  • Defined in handlers/logout.ts:98
    • diff --git a/docs/types/handlers_logout.LogoutOptionsProvider.html b/docs/types/handlers_logout.LogoutOptionsProvider.html index 6a684059c..89c85d527 100644 --- a/docs/types/handlers_logout.LogoutOptionsProvider.html +++ b/docs/types/handlers_logout.LogoutOptionsProvider.html @@ -34,7 +34,7 @@

    Parameters

    req: NextApiRequest

    Returns LogoutOptions

    +
  • Defined in handlers/logout.ts:33
    • diff --git a/docs/types/handlers_profile.AfterRefetch.html b/docs/types/handlers_profile.AfterRefetch.html index e454a4ae3..4ff802b27 100644 --- a/docs/types/handlers_profile.AfterRefetch.html +++ b/docs/types/handlers_profile.AfterRefetch.html @@ -35,7 +35,7 @@
    res: session: default

    Returns Promise<default> | default

    +
  • Defined in handlers/profile.ts:8
    • diff --git a/docs/types/handlers_profile.HandleProfile.html b/docs/types/handlers_profile.HandleProfile.html index f73369a71..f3593075d 100644 --- a/docs/types/handlers_profile.HandleProfile.html +++ b/docs/types/handlers_profile.HandleProfile.html @@ -29,16 +29,16 @@

    Type declaration

    Example

    Pass an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

    export default handleAuth({
      profile: handleProfile({ refetch: true })
    });
-
    +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

    export default handleAuth({
      profile: handleProfile((req) => {
        return { refetch: true };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the profile handler

    import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

    export default handleAuth({
      profile: async (req, res) => {
        try {
          await handleProfile(req, res, { refetch: true });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -57,16 +57,16 @@

    Returns Promise<

    Example

    Pass an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

    export default handleAuth({
      profile: handleProfile({ refetch: true })
    });
-
    +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

    export default handleAuth({
      profile: handleProfile((req) => {
        return { refetch: true };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the profile handler

    import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

    export default handleAuth({
      profile: async (req, res) => {
        try {
          await handleProfile(req, res, { refetch: true });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -81,16 +81,16 @@

    Returns // pages/api/auth/[...auth0].js
    import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

    export default handleAuth({
    profile: handleProfile({ refetch: true })
    }); - +

    Example

    Pass a function that receives the request and returns an options object

    // pages/api/auth/[...auth0].js
    import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

    export default handleAuth({
      profile: handleProfile((req) => {
        return { refetch: true };
      })
    });
-
    +

    This is useful for generating options that depend on values from the request.

    Example

    Override the profile handler

    import { handleAuth, handleProfile } from '@auth0/nextjs-auth0';

    export default handleAuth({
      profile: async (req, res) => {
        try {
          await handleProfile(req, res, { refetch: true });
        } catch (error) {
          console.error(error);
        }
      }
    });
-
    +

    Parameters

    @@ -99,7 +99,7 @@

    Parameters

    options: ProfileOptions

    Returns ProfileHandler

    +
  • Defined in handlers/profile.ts:88
    • diff --git a/docs/types/handlers_profile.ProfileHandler.html b/docs/types/handlers_profile.ProfileHandler.html index 326b11e1e..b31fb5a63 100644 --- a/docs/types/handlers_profile.ProfileHandler.html +++ b/docs/types/handlers_profile.ProfileHandler.html @@ -39,7 +39,7 @@
    res: Optional options: ProfileOptions

    Returns Promise<void>

    +
  • Defined in handlers/profile.ts:101
    • diff --git a/docs/types/handlers_profile.ProfileOptions.html b/docs/types/handlers_profile.ProfileOptions.html index f7babf92d..07112f004 100644 --- a/docs/types/handlers_profile.ProfileOptions.html +++ b/docs/types/handlers_profile.ProfileOptions.html @@ -36,7 +36,7 @@
    Optional
    +
  • Defined in handlers/profile.ts:17
    • diff --git a/docs/types/handlers_profile.ProfileOptionsProvider.html b/docs/types/handlers_profile.ProfileOptionsProvider.html index ff5b91f7d..3f6e0ad44 100644 --- a/docs/types/handlers_profile.ProfileOptionsProvider.html +++ b/docs/types/handlers_profile.ProfileOptionsProvider.html @@ -34,7 +34,7 @@

    Parameters

    req: NextApiRequest

    Returns ProfileOptions

    +
  • Defined in handlers/profile.ts:38
    • diff --git a/docs/types/helpers_testing.GenerateSessionCookieConfig.html b/docs/types/helpers_testing.GenerateSessionCookieConfig.html index 829e0bfcc..1e979c660 100644 --- a/docs/types/helpers_testing.GenerateSessionCookieConfig.html +++ b/docs/types/helpers_testing.GenerateSessionCookieConfig.html @@ -20,7 +20,7 @@

    Type alias GenerateSessionCookieConfig

    Configuration parameters used by generateSessionCookie.

    +
  • Defined in helpers/testing.ts:7
    • diff --git a/docs/types/helpers_with_api_auth_required.WithApiAuthRequired.html b/docs/types/helpers_with_api_auth_required.WithApiAuthRequired.html index e8334a0cd..f92d3724d 100644 --- a/docs/types/helpers_with_api_auth_required.WithApiAuthRequired.html +++ b/docs/types/helpers_with_api_auth_required.WithApiAuthRequired.html @@ -27,7 +27,7 @@

    Type declaration

    Wrap an API route to check that the user has a valid session. If they're not logged in the handler will return a 401 Unauthorized.

    // pages/api/protected-route.js
    import { withApiAuthRequired, getSession } from '@auth0/nextjs-auth0';

    export default withApiAuthRequired(function ProtectedRoute(req, res) {
      const session = getSession(req, res);
      ...
    });
-
    +

    If you visit /api/protected-route without a valid session cookie, you will get a 401 response.

    @@ -37,7 +37,7 @@

    Parameters

    apiRoute: NextApiHandler

    Returns NextApiHandler

    +
  • Defined in helpers/with-api-auth-required.ts:23
    • diff --git a/docs/types/helpers_with_middleware_auth_required.WithMiddlewareAuthRequired.html b/docs/types/helpers_with_middleware_auth_required.WithMiddlewareAuthRequired.html index 7ff306175..22c6c01ad 100644 --- a/docs/types/helpers_with_middleware_auth_required.WithMiddlewareAuthRequired.html +++ b/docs/types/helpers_with_middleware_auth_required.WithMiddlewareAuthRequired.html @@ -27,14 +27,14 @@

    Type declaration

    Protect your pages with Next.js Middleware. For example:

    To protect all your routes:

    // middleware.js
    import { withMiddlewareAuthRequired } from '@auth0/nextjs-auth0/edge';

    export default withMiddlewareAuthRequired();
-
    +

    To protect specific routes:

    // middleware.js
    import { withMiddlewareAuthRequired } from '@auth0/nextjs-auth0/edge';

    export default withMiddlewareAuthRequired();

    export const config = {
      matcher: '/about/:path*',
    };
-
    +

    For more info see: https://nextjs.org/docs/advanced-features/middleware#matching-paths

    To run custom middleware for authenticated users:

    // middleware.js
    import { withMiddlewareAuthRequired, getSession } from '@auth0/nextjs-auth0/edge';

    export default withMiddlewareAuthRequired(async function middleware(req) {
      const res = NextResponse.next();
      const user = await getSession(req, res);
      res.cookies.set('hl', user.language);
      return res;
    });
-
    +

    Parameters

    @@ -43,7 +43,7 @@

    Parameters

    Optional middleware: NextMiddleware

    Returns NextMiddleware

    +
  • Defined in helpers/with-middleware-auth-required.ts:46
    • diff --git a/docs/types/helpers_with_page_auth_required.GetServerSidePropsResultWithSession.html b/docs/types/helpers_with_page_auth_required.GetServerSidePropsResultWithSession.html index d63312b29..d77ffb2c6 100644 --- a/docs/types/helpers_with_page_auth_required.GetServerSidePropsResultWithSession.html +++ b/docs/types/helpers_with_page_auth_required.GetServerSidePropsResultWithSession.html @@ -20,15 +20,15 @@

    Type alias GetServerSidePropsResultWithSession<P>

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

    // pages/profile.js
    import { withPageAuthRequired } from '@auth0/nextjs-auth0';

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

    export const getServerSideProps = withPageAuthRequired();
-
    +
    -
    +

    Type Parameters

    -
      +

      • P = any

    +
  • Defined in helpers/with-page-auth-required.ts:23
    • diff --git a/docs/types/helpers_with_page_auth_required.PageRoute.html b/docs/types/helpers_with_page_auth_required.PageRoute.html index c5d55851a..f140d0e19 100644 --- a/docs/types/helpers_with_page_auth_required.PageRoute.html +++ b/docs/types/helpers_with_page_auth_required.PageRoute.html @@ -17,9 +17,9 @@
  • PageRoute

    • Type alias PageRoute<P, Q>

    PageRoute<P, Q>: ((cts) => Promise<GetServerSidePropsResultWithSession<P>>)
    -
    +

    Type Parameters

    -
      +

      • P

      • @@ -40,7 +40,7 @@

        Parameters

        cts: GetServerSidePropsContext<Q>

    Returns Promise<GetServerSidePropsResultWithSession<P>>

    +
  • Defined in helpers/with-page-auth-required.ts:30
    • diff --git a/docs/types/helpers_with_page_auth_required.WithPageAuthRequired.html b/docs/types/helpers_with_page_auth_required.WithPageAuthRequired.html index bc572ab59..9aa7565e2 100644 --- a/docs/types/helpers_with_page_auth_required.WithPageAuthRequired.html +++ b/docs/types/helpers_with_page_auth_required.WithPageAuthRequired.html @@ -27,13 +27,13 @@

    Type declaration

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

    // pages/protected-page.js
    import { withPageAuthRequired } from '@auth0/nextjs-auth0';

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

    export const getServerSideProps = 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 Parameters

    -
      +

      • P extends {
            [key: string]: any;
        } = {
            [key: string]: any;
        }

      • @@ -45,7 +45,7 @@

        Parameters

        Optional opts: WithPageAuthRequiredOptions<P, Q>

    Returns PageRoute<P, Q>

    +
  • Defined in helpers/with-page-auth-required.ts:93
    • diff --git a/docs/types/helpers_with_page_auth_required.WithPageAuthRequiredOptions.html b/docs/types/helpers_with_page_auth_required.WithPageAuthRequiredOptions.html index fa92f27ee..45cecd4c6 100644 --- a/docs/types/helpers_with_page_auth_required.WithPageAuthRequiredOptions.html +++ b/docs/types/helpers_with_page_auth_required.WithPageAuthRequiredOptions.html @@ -22,11 +22,11 @@

    Type alias WithPageAuthRequiredOptions<P, Q>

    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 { getSession, withPageAuthRequired } from '@auth0/nextjs-auth0';

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

    export const getServerSideProps = withPageAuthRequired({
      // returnTo: '/unauthorized',
      async getServerSideProps(ctx) {
        // access the user session if needed
        // const session = await getSession(ctx.req, ctx.res);
        return {
          props: {
            // customProp: 'bar',
          }
        };
      }
    });
-
    +
    -
    +

    Type Parameters

    -
      +

      • P extends {
            [key: string]: any;
        } = {
            [key: string]: any;
        }

      • @@ -39,7 +39,7 @@
        Optional
        Optional returnTo?: string
    +
  • Defined in helpers/with-page-auth-required.ts:65
    • diff --git a/docs/types/index.InitAuth0.html b/docs/types/index.InitAuth0.html index 87ec8f20e..b114088e9 100644 --- a/docs/types/index.InitAuth0.html +++ b/docs/types/index.InitAuth0.html @@ -34,7 +34,7 @@

    Parameters

    Optional params: ConfigParameters

    Returns Auth0Server

    +
  • Defined in index.ts:138
    • diff --git a/docs/types/index.SessionStore.html b/docs/types/index.SessionStore.html index fc1b28ab4..a4a89a0bc 100644 --- a/docs/types/index.SessionStore.html +++ b/docs/types/index.SessionStore.html @@ -18,7 +18,7 @@

    Type alias SessionStore

    SessionStore: GenericSessionStore<default>
    +
  • Defined in index.ts:278
    • diff --git a/docs/types/index.SessionStorePayload.html b/docs/types/index.SessionStorePayload.html index c3eef58fa..92393233f 100644 --- a/docs/types/index.SessionStorePayload.html +++ b/docs/types/index.SessionStorePayload.html @@ -18,7 +18,7 @@

    Type alias SessionStorePayload

    SessionStorePayload: SessionPayload<default>
    +
  • Defined in index.ts:279
    • diff --git a/docs/types/session_get_access_token.AfterRefresh.html b/docs/types/session_get_access_token.AfterRefresh.html index 53299f24d..7451a3f44 100644 --- a/docs/types/session_get_access_token.AfterRefresh.html +++ b/docs/types/session_get_access_token.AfterRefresh.html @@ -35,7 +35,7 @@
    res: session: default

    Returns Promise<default> | default

    +
  • Defined in session/get-access-token.ts:10
    • diff --git a/docs/types/session_get_access_token.GetAccessToken.html b/docs/types/session_get_access_token.GetAccessToken.html index 1775f7a6e..c98e9e5d5 100644 --- a/docs/types/session_get_access_token.GetAccessToken.html +++ b/docs/types/session_get_access_token.GetAccessToken.html @@ -26,7 +26,7 @@

    Type declaration

  • Get an access token to access an external API.

    -

    Throws

    AccessTokenError

    +

    Throws

    AccessTokenError

    Parameters

    @@ -39,7 +39,7 @@
    res: Optional accessTokenRequest: AccessTokenRequest

    • Returns Promise<GetAccessTokenResult>

    +
  • Defined in session/get-access-token.ts:86
    • diff --git a/docs/types/session_get_session.GetSession.html b/docs/types/session_get_session.GetSession.html index fccde81b9..15abcf599 100644 --- a/docs/types/session_get_session.GetSession.html +++ b/docs/types/session_get_session.GetSession.html @@ -35,7 +35,7 @@
    req: res: ServerResponse | NextApiResponse

    Returns Promise<default | null | undefined>

    +
  • Defined in session/get-session.ts:11
    • diff --git a/docs/types/session_touch_session.TouchSession.html b/docs/types/session_touch_session.TouchSession.html index dd5fa270c..396379d79 100644 --- a/docs/types/session_touch_session.TouchSession.html +++ b/docs/types/session_touch_session.TouchSession.html @@ -27,7 +27,7 @@

    Type declaration

    Touch the session object. If rolling sessions are enabled and autoSave is disabled, you will need to call this method to update the session expiry.

    // pages/api/graphql.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default async function graphql(req, res) {
      await touchSession(req, res);

     // ...
    };
-
    +

    Parameters

    @@ -38,7 +38,7 @@
    req: res: ServerResponse | NextApiResponse

    Returns Promise<void>

    +
  • Defined in session/touch-session.ts:23
    • diff --git a/docs/types/session_update_session.UpdateSession.html b/docs/types/session_update_session.UpdateSession.html index 297d2f50c..0eb06eead 100644 --- a/docs/types/session_update_session.UpdateSession.html +++ b/docs/types/session_update_session.UpdateSession.html @@ -28,7 +28,7 @@

    Type declaration

    Note you can't use this method to login or logout - you should use the login and logout handlers for this. If no session is provided, it doesn't contain a user or the user is not authenticated; this is a no-op.

    // pages/api/update-user.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function updateSession(req, res) {
      if (req.method === 'PUT') {
        const session = await getSession(req, res);
        updateSession(req, res, { ...session, user: { ...session.user, foo: req.query.foo } });
        res.json({ success: true });
      }
    };
-
    +

    Parameters

    @@ -41,7 +41,7 @@
    res: user: default

    Returns Promise<void>

    +
  • Defined in session/update-session.ts:27
    • diff --git a/docs/variables/version.default.html b/docs/variables/version.default.html index 6256821e2..b8de71a94 100644 --- a/docs/variables/version.default.html +++ b/docs/variables/version.default.html @@ -16,9 +16,9 @@
  • version
  • default

    • Variable default

    -
    default: "2.5.0"
    +
  • Defined in version.ts:1
    • diff --git a/package-lock.json b/package-lock.json index 0c48ed287..2ef13877f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/nextjs-auth0", - "version": "2.5.0", + "version": "2.6.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/nextjs-auth0", - "version": "2.5.0", + "version": "2.6.0", "license": "MIT", "dependencies": { "@panva/hkdf": "^1.0.2", diff --git a/package.json b/package.json index 6a1ae9e68..e53e2cbd3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@auth0/nextjs-auth0", - "version": "2.5.0", + "version": "2.6.0", "description": "Next.js SDK for signing in with Auth0", "exports": { ".": "./dist/index.js", diff --git a/src/version.ts b/src/version.ts index 7bbbdcc04..265de7683 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export default '2.5.0'; +export default '2.6.0';