Merge pull request #290 from auth0/release-1.0.0

Release 1.0.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,13 +4,13 @@ about: Create a bug report to fix an existing issue.
 title: ''
 labels: ''
 assignees: ''
-
 ---
+
 **Please do not report security vulnerabilities here**. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
 
 **Thank you in advance for helping us to improve this library!** Please read through the template below and answer all relevant questions. Your additional work here is greatly appreciated and will help us respond as quickly as possible. For general support or usage questions, use the [Auth0 Community](https://community.auth0.com/) or [Auth0 Support](https://support.auth0.com/). Finally, to avoid duplicates, please search existing Issues before submitting one here.
 
-By submitting an Issue to this repository, you agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
+By submitting an Issue to this repository, you agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/main/CODE-OF-CONDUCT.md).
 
 ### Description
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -11,7 +11,7 @@ assignees: ''
 
 Thank you in advance for helping us to improve this library! Your attention to detail here is greatly appreciated and will help us respond as quickly as possible. For general support or usage questions, use the Auth0 Community (https://community.auth0.com/) or Auth0 Support (https://support.auth0.com/). Finally, to avoid duplicates, please search existing Issues before submitting one here.
 
-By submitting an Issue to this repository, you agree to the terms within the Auth0 Code of Conduct (https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
+By submitting an Issue to this repository, you agree to the terms within the Auth0 Code of Conduct (https://github.com/auth0/open-source-template/blob/main/CODE-OF-CONDUCT.md).
 -->
 
 ### Describe the problem you'd like to have solved

.github/ISSUE_TEMPLATE/report_a_bug.md

@@ -11,7 +11,7 @@ assignees: ''
 
 Thank you in advance for helping us to improve this library! Please read through the template below and answer all relevant questions. Your additional work here is greatly appreciated and will help us respond as quickly as possible. For general support or usage questions, use the Auth0 Community (https://community.auth0.com/) or Auth0 Support (https://support.auth0.com/). Finally, to avoid duplicates, please search existing Issues before submitting one here.
 
-By submitting an Issue to this repository, you agree to the terms within the Auth0 Code of Conduct (https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
+By submitting an Issue to this repository, you agree to the terms within the Auth0 Code of Conduct (https://github.com/auth0/open-source-template/blob/main/CODE-OF-CONDUCT.md).
 -->
 
 ### Describe the problem
@@ -27,6 +27,7 @@ By submitting an Issue to this repository, you agree to the terms within the Aut
 -->
 
 ### Reproduction
+
 <!--
 > Detail the steps taken to reproduce this error, and whether this issue can be reproduced consistently or if it is intermittent.
 > **Note**: If clear, reproducable steps or the smallest sample app demonstrating misbehavior cannot be provided, we may not be able to follow up on this bug report.

.github/PULL_REQUEST_TEMPLATE.Md

@@ -1,4 +1,4 @@
-By submitting a PR to this repository, you agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md). Please see the [contributing guidelines](https://github.com/auth0/open-source-template/blob/master/CONTRIBUTING.md) for how to create and submit a high-quality PR for this repo.
+By submitting a PR to this repository, you agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/main/CODE-OF-CONDUCT.md). Please see the [contributing guidelines](https://github.com/auth0/open-source-template/blob/main/CONTRIBUTING.md) for how to create and submit a high-quality PR for this repo.
 
 ### Description
 
@@ -35,4 +35,4 @@ By submitting a PR to this repository, you agree to the terms within the [Auth0
 
 - [ ] I have added documentation for new/changed functionality in this PR or in auth0.com/docs
 - [ ] All active GitHub checks for tests, formatting, and security are passing
-- [ ] The correct base branch is being used, if not `master`
+- [ ] The correct base branch is being used, if not `main`

CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.0.0](https://github.com/auth0/nextjs-auth0/tree/v1.0.0) (2021-02-15)
+
+**New features**
+
+- New suite of frontend tools:
+  - `useUser` hook and `UserProvider` to simplify checking and managing the user’s logged in state on the client.
+  - `withPageAuthRequired` higher order component to protect client side routes.
+- New `handleAuth` feature to reduce the amount of boilerplate required to set up the server side authentication handlers.
+- Simpler server side API where creation of an SDK instance is handled by the SDK.
+
+**Breaking changes**
+
+For a full list of breaking changes and migration guide, checkout the [V1_MIGRATION_GUIDE.md](./V1_MIGRATION_GUIDE.md)
+
 ## [1.0.0-beta.2](https://github.com/auth0/nextjs-auth0/tree/v1.0.0-beta.2) (2021-02-11)
 
 **Additions**

README.md

@@ -1,10 +1,8 @@
-# @auth0/nextjs-auth0 Beta
+# @auth0/nextjs-auth0
 
 Auth0 SDK for signing in to your Next.js applications.
 
-> Note: This library is currently in **Beta** and has not had a complete security review. We do not recommend using this library in production yet. As we move towards general availability, please be aware that releases may contain breaking changes.
-
-[![CircleCI](https://img.shields.io/circleci/build/github/auth0/nextjs-auth0/beta?style=flat-square)](https://circleci.com/gh/auth0/nextjs-auth0/tree/beta)
+[![CircleCI](https://img.shields.io/circleci/build/github/auth0/nextjs-auth0/main?style=flat-square)](https://circleci.com/gh/auth0/nextjs-auth0/tree/main)
 [![NPM version](https://img.shields.io/npm/v/@auth0/nextjs-auth0.svg?style=flat-square)](https://npmjs.org/package/@auth0/nextjs-auth0)
 [![License](https://img.shields.io/:license-mit-blue.svg?style=flat)](https://opensource.org/licenses/MIT)
 
@@ -32,7 +30,7 @@ Auth0 SDK for signing in to your Next.js applications.
 Using [npm](https://npmjs.org):
 
 ```sh
-npm install @auth0/nextjs-auth0@beta
+npm install @auth0/nextjs-auth0
 ```
 
 > Note that this package supports the following versions of Node.js: `^10.13.0 || >=12.0.0` and the following versions of Next.js: `>=10`.
@@ -184,7 +182,7 @@ If you're using Jest, we recommend using `jest.resetModules()` after each test.
 
 We appreciate feedback and contribution to this repo! Before you get started, please see the following:
 
-- [Auth0's general contribution guidelines](https://github.com/auth0/.github/blob/master/CONTRIBUTING.md)
+- [Auth0's general contribution guidelines](./CONTRIBUTING.md)
 - [Auth0's code of conduct guidelines](./CODE-OF-CONDUCT.md)
 
 Run NPM install first to install the dependencies of this project:

V1_MIGRATION_GUIDE.md

@@ -1,6 +1,6 @@
 # V1 Migration Guide
 
-Guide to migrating from `0.x` to `1.x` (Beta)
+Guide to migrating from `0.x` to `1.x`
 
 ### Config changes
 

docs/classes/session.sessioncache.html

@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>SessionCache | @auth0/nextjs-auth0 (Beta Only)</title>
-	<meta name="description" content="Documentation for @auth0/nextjs-auth0 (Beta Only)">
+	<title>SessionCache | @auth0/nextjs-auth0</title>
+	<meta name="description" content="Documentation for @auth0/nextjs-auth0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@auth0/nextjs-auth0 (Beta Only)</a>
+					<a href="../index.html" class="title">@auth0/nextjs-auth0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -50,7 +50,7 @@
 		<div class="container">
 			<ul class="tsd-breadcrumb">
 				<li>
-					<a href="../index.html">@auth0/nextjs-auth0 (Beta Only)</a>
+					<a href="../index.html">@auth0/nextjs-auth0</a>
 				</li>
 				<li>
 					<a href="../modules/session.html">session</a>
@@ -118,7 +118,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/cache.ts#L12">src/session/cache.ts:12</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/cache.ts#L12">src/session/cache.ts:12</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -147,7 +147,7 @@ <h3>create</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/cache.ts#L26">src/session/cache.ts:26</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/cache.ts#L26">src/session/cache.ts:26</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -176,7 +176,7 @@ <h3>delete</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/cache.ts#L31">src/session/cache.ts:31</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/cache.ts#L31">src/session/cache.ts:31</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -202,7 +202,7 @@ <h3>from<wbr>Token<wbr>Set</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/cache.ts#L58">src/session/cache.ts:58</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/cache.ts#L58">src/session/cache.ts:58</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -225,7 +225,7 @@ <h3>get</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/cache.ts#L53">src/session/cache.ts:53</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/cache.ts#L53">src/session/cache.ts:53</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -251,7 +251,7 @@ <h3>get<wbr>IdToken</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/cache.ts#L42">src/session/cache.ts:42</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/cache.ts#L42">src/session/cache.ts:42</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -277,7 +277,7 @@ <h3>init</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/cache.ts#L18">src/session/cache.ts:18</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/cache.ts#L18">src/session/cache.ts:18</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -303,7 +303,7 @@ <h3>is<wbr>Authenticated</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/cache.ts#L36">src/session/cache.ts:36</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/cache.ts#L36">src/session/cache.ts:36</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -329,7 +329,7 @@ <h3>set</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/cache.ts#L48">src/session/cache.ts:48</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/cache.ts#L48">src/session/cache.ts:48</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>

docs/classes/session_session.default.html

@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>default | @auth0/nextjs-auth0 (Beta Only)</title>
-	<meta name="description" content="Documentation for @auth0/nextjs-auth0 (Beta Only)">
+	<title>default | @auth0/nextjs-auth0</title>
+	<meta name="description" content="Documentation for @auth0/nextjs-auth0">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 	<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">@auth0/nextjs-auth0 (Beta Only)</a>
+					<a href="../index.html" class="title">@auth0/nextjs-auth0</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -50,7 +50,7 @@
 		<div class="container">
 			<ul class="tsd-breadcrumb">
 				<li>
-					<a href="../index.html">@auth0/nextjs-auth0 (Beta Only)</a>
+					<a href="../index.html">@auth0/nextjs-auth0</a>
 				</li>
 				<li>
 					<a href="../modules/session_session.html">session/session</a>
@@ -126,7 +126,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/session.ts#L50">src/session/session.ts:50</a></li>
+									<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/session.ts#L50">src/session/session.ts:50</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Token</h3>
 					<div class="tsd-signature tsd-kind-icon">access<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/session.ts#L33">src/session/session.ts:33</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/session.ts#L33">src/session/session.ts:33</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -163,7 +163,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Token<wbr>
 					<div class="tsd-signature tsd-kind-icon">access<wbr>Token<wbr>Expires<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/session.ts#L43">src/session/session.ts:43</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/session.ts#L43">src/session/session.ts:43</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -178,7 +178,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Token<wbr>
 					<div class="tsd-signature tsd-kind-icon">access<wbr>Token<wbr>Scope<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/session.ts#L38">src/session/session.ts:38</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/session.ts#L38">src/session/session.ts:38</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -193,7 +193,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> id<wbr>Token</h3>
 					<div class="tsd-signature tsd-kind-icon">id<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/session.ts#L28">src/session/session.ts:28</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/session.ts#L28">src/session/session.ts:28</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -208,7 +208,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> refresh<wbr>Token</h3
 					<div class="tsd-signature tsd-kind-icon">refresh<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/session.ts#L48">src/session/session.ts:48</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/session.ts#L48">src/session/session.ts:48</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -223,7 +223,7 @@ <h3>user</h3>
 					<div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">:</span> <a href="../interfaces/session_session.claims.html" class="tsd-signature-type" data-tsd-kind="Interface">Claims</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/e13ed3d/src/session/session.ts#L23">src/session/session.ts:23</a></li>
+							<li>Defined in <a href="https://github.com/auth0/nextjs-auth0/blob/56637e5/src/session/session.ts#L23">src/session/session.ts:23</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">