Skip to content

Commit a822c7b

Browse files
adamjmcgrathadamjmcgrath
committed
Release 1.0.0
1 parent 56637e5 commit a822c7b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+321
-16748
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ about: Create a bug report to fix an existing issue.
44
title: ''
55
labels: ''
66
assignees: ''
7-
87
---
8+
99
**Please do not report security vulnerabilities here**. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
1010

1111
**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.
1212

13-
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).
13+
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).
1414

1515
### Description
1616

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ assignees: ''
1111
1212
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.
1313
14-
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).
14+
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).
1515
-->
1616

1717
### Describe the problem you'd like to have solved
@@ -36,4 +36,4 @@ By submitting an Issue to this repository, you agree to the terms within the Aut
3636

3737
<!--
3838
> Add any other context or screenshots about the feature request here.
39-
-->
39+
-->

‎.github/ISSUE_TEMPLATE/report_a_bug.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ assignees: ''
1111
1212
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.
1313
14-
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).
14+
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).
1515
-->
1616

1717
### Describe the problem
@@ -27,6 +27,7 @@ By submitting an Issue to this repository, you agree to the terms within the Aut
2727
-->
2828

2929
### Reproduction
30+
3031
<!--
3132
> Detail the steps taken to reproduce this error, and whether this issue can be reproduced consistently or if it is intermittent.
3233
> **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.
@@ -52,4 +53,4 @@ By submitting an Issue to this repository, you agree to the terms within the Aut
5253
- **Version of this library used:**
5354
- **Which framework are you using, if applicable:**
5455
- **Other modules/plugins/libraries that might be involved:**
55-
- **Any other relevant information you think would be useful:**
56+
- **Any other relevant information you think would be useful:**

‎.github/PULL_REQUEST_TEMPLATE.Md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
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.
1+
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.
22

33
### Description
44

@@ -35,4 +35,4 @@ By submitting a PR to this repository, you agree to the terms within the [Auth0
3535

3636
- [ ] I have added documentation for new/changed functionality in this PR or in auth0.com/docs
3737
- [ ] All active GitHub checks for tests, formatting, and security are passing
38-
- [ ] The correct base branch is being used, if not `master`
38+
- [ ] The correct base branch is being used, if not `main`

‎CHANGELOG.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
## [1.0.0](https://github.com/auth0/nextjs-auth0/tree/v1.0.0) (2021-02-15)
2+
3+
**New features**
4+
5+
- New suite of frontend tools:
6+
- `useUser` hook and `UserProvider` to simplify checking and managing the user’s logged in state on the client.
7+
- `withPageAuthRequired` higher order component to protect client side routes.
8+
- New `handleAuth` feature to reduce the amount of boilerplate required to set up the server side authentication handlers.
9+
- Simpler server side API where creation of an SDK instance is handled by the SDK.
10+
11+
**Breaking changes**
12+
13+
For a full list of breaking changes and migration guide, checkout the [V1_MIGRATION_GUIDE.md](./V1_MIGRATION_GUIDE.md)
14+
115
## [1.0.0-beta.2](https://github.com/auth0/nextjs-auth0/tree/v1.0.0-beta.2) (2021-02-11)
216

317
**Additions**

‎README.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
# @auth0/nextjs-auth0 Beta
1+
# @auth0/nextjs-auth0
22

33
Auth0 SDK for signing in to your Next.js applications.
44

5-
> 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.
6-
7-
[![CircleCI](https://img.shields.io/circleci/build/github/auth0/nextjs-auth0/beta?style=flat-square)](https://circleci.com/gh/auth0/nextjs-auth0/tree/beta)
5+
[![CircleCI](https://img.shields.io/circleci/build/github/auth0/nextjs-auth0/main?style=flat-square)](https://circleci.com/gh/auth0/nextjs-auth0/tree/main)
86
[![NPM version](https://img.shields.io/npm/v/@auth0/nextjs-auth0.svg?style=flat-square)](https://npmjs.org/package/@auth0/nextjs-auth0)
97
[![License](https://img.shields.io/:license-mit-blue.svg?style=flat)](https://opensource.org/licenses/MIT)
108

@@ -32,7 +30,7 @@ Auth0 SDK for signing in to your Next.js applications.
3230
Using [npm](https://npmjs.org):
3331

3432
```sh
35-
npm install @auth0/nextjs-auth0@beta
33+
npm install @auth0/nextjs-auth0
3634
```
3735

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

185183
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
186184

187-
- [Auth0's general contribution guidelines](https://github.com/auth0/.github/blob/master/CONTRIBUTING.md)
185+
- [Auth0's general contribution guidelines](./CONTRIBUTING.md)
188186
- [Auth0's code of conduct guidelines](./CODE-OF-CONDUCT.md)
189187

190188
Run NPM install first to install the dependencies of this project:

‎V1_MIGRATION_GUIDE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# V1 Migration Guide
22

3-
Guide to migrating from `0.x` to `1.x` (Beta)
3+
Guide to migrating from `0.x` to `1.x`
44

55
### Config changes
66

‎docs/classes/session.sessioncache.html‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>SessionCache | @auth0/nextjs-auth0 (Beta Only)</title>
7-
<meta name="description" content="Documentation for @auth0/nextjs-auth0 (Beta Only)">
6+
<title>SessionCache | @auth0/nextjs-auth0</title>
7+
<meta name="description" content="Documentation for @auth0/nextjs-auth0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
1010
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
2323
<li class="state loading">Preparing search index...</li>
2424
<li class="state failure">The search index is not available</li>
2525
</ul>
26-
<a href="../index.html" class="title">@auth0/nextjs-auth0 (Beta Only)</a>
26+
<a href="../index.html" class="title">@auth0/nextjs-auth0</a>
2727
</div>
2828
<div class="table-cell" id="tsd-widgets">
2929
<div id="tsd-filter">
@@ -50,7 +50,7 @@
5050
<div class="container">
5151
<ul class="tsd-breadcrumb">
5252
<li>
53-
<a href="../index.html">@auth0/nextjs-auth0 (Beta Only)</a>
53+
<a href="../index.html">@auth0/nextjs-auth0</a>
5454
</li>
5555
<li>
5656
<a href="../modules/session.html">session</a>
@@ -118,7 +118,7 @@ <h3>constructor</h3>
118118
<li class="tsd-description">
119119
<aside class="tsd-sources">
120120
<ul>
121-
<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>
121+
<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>
122122
</ul>
123123
</aside>
124124
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -147,7 +147,7 @@ <h3>create</h3>
147147
<li class="tsd-description">
148148
<aside class="tsd-sources">
149149
<ul>
150-
<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>
150+
<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>
151151
</ul>
152152
</aside>
153153
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -176,7 +176,7 @@ <h3>delete</h3>
176176
<li class="tsd-description">
177177
<aside class="tsd-sources">
178178
<ul>
179-
<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>
179+
<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>
180180
</ul>
181181
</aside>
182182
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -202,7 +202,7 @@ <h3>from<wbr>Token<wbr>Set</h3>
202202
<li class="tsd-description">
203203
<aside class="tsd-sources">
204204
<ul>
205-
<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>
205+
<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>
206206
</ul>
207207
</aside>
208208
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -225,7 +225,7 @@ <h3>get</h3>
225225
<li class="tsd-description">
226226
<aside class="tsd-sources">
227227
<ul>
228-
<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>
228+
<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>
229229
</ul>
230230
</aside>
231231
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -251,7 +251,7 @@ <h3>get<wbr>IdToken</h3>
251251
<li class="tsd-description">
252252
<aside class="tsd-sources">
253253
<ul>
254-
<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>
254+
<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>
255255
</ul>
256256
</aside>
257257
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -277,7 +277,7 @@ <h3>init</h3>
277277
<li class="tsd-description">
278278
<aside class="tsd-sources">
279279
<ul>
280-
<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>
280+
<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>
281281
</ul>
282282
</aside>
283283
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -303,7 +303,7 @@ <h3>is<wbr>Authenticated</h3>
303303
<li class="tsd-description">
304304
<aside class="tsd-sources">
305305
<ul>
306-
<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>
306+
<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>
307307
</ul>
308308
</aside>
309309
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -329,7 +329,7 @@ <h3>set</h3>
329329
<li class="tsd-description">
330330
<aside class="tsd-sources">
331331
<ul>
332-
<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>
332+
<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>
333333
</ul>
334334
</aside>
335335
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/session_session.default.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>default | @auth0/nextjs-auth0 (Beta Only)</title>
7-
<meta name="description" content="Documentation for @auth0/nextjs-auth0 (Beta Only)">
6+
<title>default | @auth0/nextjs-auth0</title>
7+
<meta name="description" content="Documentation for @auth0/nextjs-auth0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
1010
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
2323
<li class="state loading">Preparing search index...</li>
2424
<li class="state failure">The search index is not available</li>
2525
</ul>
26-
<a href="../index.html" class="title">@auth0/nextjs-auth0 (Beta Only)</a>
26+
<a href="../index.html" class="title">@auth0/nextjs-auth0</a>
2727
</div>
2828
<div class="table-cell" id="tsd-widgets">
2929
<div id="tsd-filter">
@@ -50,7 +50,7 @@
5050
<div class="container">
5151
<ul class="tsd-breadcrumb">
5252
<li>
53-
<a href="../index.html">@auth0/nextjs-auth0 (Beta Only)</a>
53+
<a href="../index.html">@auth0/nextjs-auth0</a>
5454
</li>
5555
<li>
5656
<a href="../modules/session_session.html">session/session</a>
@@ -126,7 +126,7 @@ <h3>constructor</h3>
126126
<li class="tsd-description">
127127
<aside class="tsd-sources">
128128
<ul>
129-
<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>
129+
<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>
130130
</ul>
131131
</aside>
132132
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Token</h3>
148148
<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>
149149
<aside class="tsd-sources">
150150
<ul>
151-
<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>
151+
<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>
152152
</ul>
153153
</aside>
154154
<div class="tsd-comment tsd-typography">
@@ -163,7 +163,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Token<wbr>
163163
<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>
164164
<aside class="tsd-sources">
165165
<ul>
166-
<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>
166+
<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>
167167
</ul>
168168
</aside>
169169
<div class="tsd-comment tsd-typography">
@@ -178,7 +178,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Token<wbr>
178178
<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>
179179
<aside class="tsd-sources">
180180
<ul>
181-
<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>
181+
<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>
182182
</ul>
183183
</aside>
184184
<div class="tsd-comment tsd-typography">
@@ -193,7 +193,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> id<wbr>Token</h3>
193193
<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>
194194
<aside class="tsd-sources">
195195
<ul>
196-
<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>
196+
<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>
197197
</ul>
198198
</aside>
199199
<div class="tsd-comment tsd-typography">
@@ -208,7 +208,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> refresh<wbr>Token</h3
208208
<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>
209209
<aside class="tsd-sources">
210210
<ul>
211-
<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>
211+
<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>
212212
</ul>
213213
</aside>
214214
<div class="tsd-comment tsd-typography">
@@ -223,7 +223,7 @@ <h3>user</h3>
223223
<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>
224224
<aside class="tsd-sources">
225225
<ul>
226-
<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>
226+
<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>
227227
</ul>
228228
</aside>
229229
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)