Merge pull request #169 from auth0/release-2.1.0

Release 2.1.0
auth0 · Dec 15, 2020 · d46116b · d46116b
2 parents df1d82b + 6714ec8
commit d46116b
Show file tree

Hide file tree

Showing 16 changed files with 3,080 additions and 175 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## [2.1.0](https://github.com/auth0/express-openid-connect/tree/v2.1.0) (2020-12-15)
+[Full Changelog](https://github.com/auth0/express-openid-connect/compare/v2.0.0...v2.1.0)
+
+**Changed**
+- Default cookie.secure config to the protocol of baseURL [#159](https://github.com/auth0/express-openid-connect/pull/159) ([adamjmcgrath](https://github.com/adamjmcgrath))
+
+**Fixed**
+- Fix session.cookie TS definitions [#157](https://github.com/auth0/express-openid-connect/pull/157) ([adamjmcgrath](https://github.com/adamjmcgrath))
+
 ## [2.0.0-beta.0](https://github.com/auth0/express-openid-connect/tree/v2.0.0-beta.0) (2020-08-31)
 [Full Changelog](https://github.com/auth0/express-openid-connect/compare/v1.0.2...v2.0.0-beta.0)
 

diff --git a/docs/assets/js/search.json b/docs/assets/js/search.json
diff --git a/docs/globals.html b/docs/globals.html
@@ -2726,6 +2726,9 @@
 		<li class=" tsd-kind-interface">
 			<a href="interfaces/configparams.html" class="tsd-kind-icon">Config<wbr>Params</a>
 		</li>
+		<li class=" tsd-kind-interface">
+			<a href="interfaces/cookieconfigparams.html" class="tsd-kind-icon">Cookie<wbr>Config<wbr>Params</a>
+		</li>
 		<li class=" tsd-kind-interface">
 			<a href="interfaces/loginoptions.html" class="tsd-kind-icon">Login<wbr>Options</a>
 		</li>
@@ -2776,7 +2779,8 @@ <h1>Express OpenID Connect</h1>
 			<p>Express JS middleware implementing sign on for Express web apps using OpenID Connect.</p>
 			<p><a href="https://circleci.com/gh/auth0/express-openid-connect/tree/master"><img src="https://img.shields.io/circleci/build/github/auth0/express-openid-connect/master?style=flat-square" alt="CircleCI"></a>
 				<a href="https://codecov.io/gh/auth0/express-openid-connect"><img src="https://img.shields.io/codecov/c/github/auth0/express-openid-connect?style=flat-square" alt="codecov"></a>
-			<a href="https://npmjs.org/package/express-openid-connect"><img src="https://img.shields.io/npm/v/express-openid-connect.svg?style=flat-square" alt="NPM version"></a></p>
+				<a href="https://npmjs.org/package/express-openid-connect"><img src="https://img.shields.io/npm/v/express-openid-connect.svg?style=flat-square" alt="NPM version"></a>
+			<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Fexpress-openid-connect?ref=badge_shield"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Fexpress-openid-connect.svg?type=shield" alt="FOSSA Status"></a></p>
 			<a href="#table-of-contents" id="table-of-contents" style="color: inherit; text-decoration: none;">
 				<h2>Table of Contents</h2>
 			</a>
@@ -2787,6 +2791,7 @@ <h2>Table of Contents</h2>
 				<li><a href="./ARCHITECTURE.md">Architecture</a></li>
 				<li><a href="#contributing">Contributing</a></li>
 				<li><a href="./TROUBLESHOOTING.md">Troubleshooting</a></li>
+				<li><a href="./FAQ.md">FAQs</a></li>
 				<li><a href="#support--feedback">Support + Feedback</a></li>
 				<li><a href="#vulnerability-reporting">Vulnerability Reporting</a></li>
 				<li><a href="#what-is-auth0">What is Auth0</a></li>
@@ -2804,7 +2809,7 @@ <h2>Documentation</h2>
 			<a href="#install" id="install" style="color: inherit; text-decoration: none;">
 				<h2>Install</h2>
 			</a>
-			<p>Node.js version <strong>&gt;=12.0.0</strong> is recommended, but <strong>^10.13.0</strong> lts/dubnium is also supported.</p>
+			<p>Node.js version <strong>&gt;=12.0.0</strong> is recommended, but <strong>^10.19.0</strong> lts/dubnium is also supported.</p>
 			<pre><code class="language-bash">npm install express-openid-connect</code></pre>
 			<a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;">
 				<h2>Getting Started</h2>
@@ -2874,6 +2879,7 @@ <h2>What is Auth0?</h2>
 				<h2>License</h2>
 			</a>
 			<p>This project is licensed under the MIT license. See the <a href="LICENSE">LICENSE</a> file for more info.</p>
+			<p><a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Fexpress-openid-connect?ref=badge_large"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Fexpress-openid-connect.svg?type=large" alt="FOSSA Status"></a></p>
 		</div>
 		<section class="tsd-panel-group tsd-index-group">
 			<h2>Index</h2>
@@ -2884,6 +2890,7 @@ <h3>Interfaces</h3>
 						<ul class="tsd-index-list">
 							<li class="tsd-kind-interface"><a href="interfaces/accesstoken.html" class="tsd-kind-icon">Access<wbr>Token</a></li>
 							<li class="tsd-kind-interface"><a href="interfaces/configparams.html" class="tsd-kind-icon">Config<wbr>Params</a></li>
+							<li class="tsd-kind-interface"><a href="interfaces/cookieconfigparams.html" class="tsd-kind-icon">Cookie<wbr>Config<wbr>Params</a></li>
 							<li class="tsd-kind-interface"><a href="interfaces/loginoptions.html" class="tsd-kind-icon">Login<wbr>Options</a></li>
 							<li class="tsd-kind-interface"><a href="interfaces/logoutoptions.html" class="tsd-kind-icon">Logout<wbr>Options</a></li>
 							<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/openidrequest.html" class="tsd-kind-icon">Openid<wbr>Request</a></li>
@@ -2919,7 +2926,7 @@ <h3>attempt<wbr>Silent<wbr>Login</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L625">index.d.ts:625</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L637">index.d.ts:637</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -2950,7 +2957,7 @@ <h3>auth</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L525">index.d.ts:525</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L537">index.d.ts:537</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3000,7 +3007,7 @@ <h3>claim<wbr>Check</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L605">index.d.ts:605</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L617">index.d.ts:617</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3057,7 +3064,7 @@ <h3>claim<wbr>Equals</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L566">index.d.ts:566</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L578">index.d.ts:578</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3100,7 +3107,7 @@ <h3>claim<wbr>Includes</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L586">index.d.ts:586</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L598">index.d.ts:598</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3143,7 +3150,7 @@ <h3>requires<wbr>Auth</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L547">index.d.ts:547</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L559">index.d.ts:559</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">

diff --git a/docs/index.html b/docs/index.html
@@ -2726,6 +2726,9 @@
 		<li class=" tsd-kind-interface">
 			<a href="interfaces/configparams.html" class="tsd-kind-icon">Config<wbr>Params</a>
 		</li>
+		<li class=" tsd-kind-interface">
+			<a href="interfaces/cookieconfigparams.html" class="tsd-kind-icon">Cookie<wbr>Config<wbr>Params</a>
+		</li>
 		<li class=" tsd-kind-interface">
 			<a href="interfaces/loginoptions.html" class="tsd-kind-icon">Login<wbr>Options</a>
 		</li>
@@ -2776,7 +2779,8 @@ <h1>Express OpenID Connect</h1>
 			<p>Express JS middleware implementing sign on for Express web apps using OpenID Connect.</p>
 			<p><a href="https://circleci.com/gh/auth0/express-openid-connect/tree/master"><img src="https://img.shields.io/circleci/build/github/auth0/express-openid-connect/master?style=flat-square" alt="CircleCI"></a>
 				<a href="https://codecov.io/gh/auth0/express-openid-connect"><img src="https://img.shields.io/codecov/c/github/auth0/express-openid-connect?style=flat-square" alt="codecov"></a>
-			<a href="https://npmjs.org/package/express-openid-connect"><img src="https://img.shields.io/npm/v/express-openid-connect.svg?style=flat-square" alt="NPM version"></a></p>
+				<a href="https://npmjs.org/package/express-openid-connect"><img src="https://img.shields.io/npm/v/express-openid-connect.svg?style=flat-square" alt="NPM version"></a>
+			<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Fexpress-openid-connect?ref=badge_shield"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Fexpress-openid-connect.svg?type=shield" alt="FOSSA Status"></a></p>
 			<a href="#table-of-contents" id="table-of-contents" style="color: inherit; text-decoration: none;">
 				<h2>Table of Contents</h2>
 			</a>
@@ -2787,6 +2791,7 @@ <h2>Table of Contents</h2>
 				<li><a href="./ARCHITECTURE.md">Architecture</a></li>
 				<li><a href="#contributing">Contributing</a></li>
 				<li><a href="./TROUBLESHOOTING.md">Troubleshooting</a></li>
+				<li><a href="./FAQ.md">FAQs</a></li>
 				<li><a href="#support--feedback">Support + Feedback</a></li>
 				<li><a href="#vulnerability-reporting">Vulnerability Reporting</a></li>
 				<li><a href="#what-is-auth0">What is Auth0</a></li>
@@ -2804,7 +2809,7 @@ <h2>Documentation</h2>
 			<a href="#install" id="install" style="color: inherit; text-decoration: none;">
 				<h2>Install</h2>
 			</a>
-			<p>Node.js version <strong>&gt;=12.0.0</strong> is recommended, but <strong>^10.13.0</strong> lts/dubnium is also supported.</p>
+			<p>Node.js version <strong>&gt;=12.0.0</strong> is recommended, but <strong>^10.19.0</strong> lts/dubnium is also supported.</p>
 			<pre><code class="language-bash">npm install express-openid-connect</code></pre>
 			<a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;">
 				<h2>Getting Started</h2>
@@ -2874,6 +2879,7 @@ <h2>What is Auth0?</h2>
 				<h2>License</h2>
 			</a>
 			<p>This project is licensed under the MIT license. See the <a href="LICENSE">LICENSE</a> file for more info.</p>
+			<p><a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Fexpress-openid-connect?ref=badge_large"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Fexpress-openid-connect.svg?type=large" alt="FOSSA Status"></a></p>
 		</div>
 		<div style="position:relative;"><a name="typedoc-main-index" class="tsd-anchor"></a></div>
 		<section class="tsd-panel-group tsd-index-group">
@@ -2885,6 +2891,7 @@ <h3>Interfaces</h3>
 						<ul class="tsd-index-list">
 							<li class="tsd-kind-interface"><a href="interfaces/accesstoken.html" class="tsd-kind-icon">Access<wbr>Token</a></li>
 							<li class="tsd-kind-interface"><a href="interfaces/configparams.html" class="tsd-kind-icon">Config<wbr>Params</a></li>
+							<li class="tsd-kind-interface"><a href="interfaces/cookieconfigparams.html" class="tsd-kind-icon">Cookie<wbr>Config<wbr>Params</a></li>
 							<li class="tsd-kind-interface"><a href="interfaces/loginoptions.html" class="tsd-kind-icon">Login<wbr>Options</a></li>
 							<li class="tsd-kind-interface"><a href="interfaces/logoutoptions.html" class="tsd-kind-icon">Logout<wbr>Options</a></li>
 							<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/openidrequest.html" class="tsd-kind-icon">Openid<wbr>Request</a></li>
@@ -2920,7 +2927,7 @@ <h3>attempt<wbr>Silent<wbr>Login</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L625">index.d.ts:625</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L637">index.d.ts:637</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -2951,7 +2958,7 @@ <h3>auth</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L525">index.d.ts:525</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L537">index.d.ts:537</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3001,7 +3008,7 @@ <h3>claim<wbr>Check</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L605">index.d.ts:605</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L617">index.d.ts:617</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3058,7 +3065,7 @@ <h3>claim<wbr>Equals</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L566">index.d.ts:566</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L578">index.d.ts:578</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3101,7 +3108,7 @@ <h3>claim<wbr>Includes</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L586">index.d.ts:586</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L598">index.d.ts:598</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">
@@ -3144,7 +3151,7 @@ <h3>requires<wbr>Auth</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L547">index.d.ts:547</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L559">index.d.ts:559</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">

diff --git a/docs/interfaces/accesstoken.html b/docs/interfaces/accesstoken.html
@@ -2743,6 +2743,9 @@
 		<li class=" tsd-kind-interface">
 			<a href="configparams.html" class="tsd-kind-icon">Config<wbr>Params</a>
 		</li>
+		<li class=" tsd-kind-interface">
+			<a href="cookieconfigparams.html" class="tsd-kind-icon">Cookie<wbr>Config<wbr>Params</a>
+		</li>
 		<li class=" tsd-kind-interface">
 			<a href="loginoptions.html" class="tsd-kind-icon">Login<wbr>Options</a>
 		</li>
@@ -2824,7 +2827,7 @@ <h3>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">string</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L466">index.d.ts:466</a></li>
+						<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L478">index.d.ts:478</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2839,7 +2842,7 @@ <h3>expires_<wbr>in</h3>
 				<div class="tsd-signature tsd-kind-icon">expires_<wbr>in<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/express-openid-connect/blob/c13cfd2/index.d.ts#L476">index.d.ts:476</a></li>
+						<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L488">index.d.ts:488</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2854,7 +2857,7 @@ <h3>is<wbr>Expired</h3>
 				<div class="tsd-signature tsd-kind-icon">is<wbr>Expired<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></div>
 				<aside class="tsd-sources">
 					<ul>
-						<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L481">index.d.ts:481</a></li>
+						<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L493">index.d.ts:493</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2884,7 +2887,7 @@ <h3>token_<wbr>type</h3>
 				<div class="tsd-signature tsd-kind-icon">token_<wbr>type<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/express-openid-connect/blob/c13cfd2/index.d.ts#L471">index.d.ts:471</a></li>
+						<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L483">index.d.ts:483</a></li>
 					</ul>
 				</aside>
 				<div class="tsd-comment tsd-typography">
@@ -2906,7 +2909,7 @@ <h3>refresh</h3>
 					<li class="tsd-description">
 						<aside class="tsd-sources">
 							<ul>
-								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/c13cfd2/index.d.ts#L493">index.d.ts:493</a></li>
+								<li>Defined in <a href="https://github.com/auth0/express-openid-connect/blob/df1d82b/index.d.ts#L505">index.d.ts:505</a></li>
 							</ul>
 						</aside>
 						<div class="tsd-comment tsd-typography">