docs: rebuild

Author: jankapunkt

docs/ExpressOAuthServer.html

@@ -891,7 +891,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ExpressOA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Jan 09 2024 09:13:55 GMT+0100 (Central European Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.3</a> on Wed Jul 31 2024 15:05:40 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/global.html

@@ -182,7 +182,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ExpressOA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Jan 09 2024 09:13:55 GMT+0100 (Central European Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.3</a> on Wed Jul 31 2024 15:05:40 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/index.html

@@ -43,16 +43,32 @@ <h3> </h3>
 
 
     <section>
-        <article><h1>Express OAuth Server</h1>
-<p>Complete, compliant and well tested module for implementing an OAuth2 Server/Provider with <a href="https://github.com/expressjs/express">express</a> in <a href="http://nodejs.org/">node.js</a>.</p>
+        <article><div align="center">
+  <h1>Express OAuth Server</h1>
+</div>
+<p align="center">
+Complete, compliant and well tested module for implementing an OAuth2 Server/Provider with <a alt="express" href="https://github.com/expressjs/express">express</a> in <a alt="node.js" href="http://nodejs.org/">Node.js</a>.
+</p>
+<div align="center">
 <p><a href="https://github.com/node-oauth/express-oauth-server/actions/workflows/tests.yml"><img src="https://github.com/node-oauth/express-oauth-server/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
 <a href="https://github.com/node-oauth/express-oauth-server/actions/workflows/github-code-scanning/codeql"><img src="https://github.com/node-oauth/express-oauth-server/actions/workflows/github-code-scanning/codeql/badge.svg" alt="CodeQL"></a>
 <a href="https://www.repostatus.org/#active"><img src="https://www.repostatus.org/badges/latest/active.svg" alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed."></a>
 <a href="https://www.npmjs.com/package/@node-oauth/oauth2-server"><img src="https://img.shields.io/npm/v/@node-oauth/express-oauth-server?label=version" alt="npm Version"></a>
 <a href="https://www.npmjs.com/package/@node-oauth/oauth2-server"><img src="https://img.shields.io/npm/dw/@node-oauth/express-oauth-server" alt="npm Downloads/Week"></a>
 <img src="https://img.shields.io/github/license/node-oauth/express-oauth-server" alt="GitHub"></p>
-<p>This is the express wrapper for <a href="https://github.com/node-oauth/node-oauth2-server">@node-oauth/oauth2-server</a>,
-it's a fork from the former <a href="https://github.com/oauthjs/express-oauth-server">oauthjs/express-oauth-server</a>.</p>
+</div>
+<div align="center">
+<p><a href="https://node-oauth.github.io/express-oauth-server/">API Docs</a>
+·
+<a href="https://www.npmjs.com/package/@node-oauth/express-oauth-server">NPM Link</a>
+·
+<a href="https://github.com/node-oauth/node-oauth2-server">Node OAuth2 Server</a></p>
+</div>
+<h2>About</h2>
+<p>This package wraps the <a href="https://github.com/node-oauth/node-oauth2-server">@node-oauth/oauth2-server</a> into an
+express compatible middleware.
+It's a maintained and up-to-date fork from the former
+<a href="https://github.com/oauthjs/express-oauth-server">oauthjs/express-oauth-server</a>.</p>
 <h2>Installation</h2>
 <pre class="prettyprint source lang-shell"><code>$ npm install @node-oauth/express-oauth-server
 </code></pre>
@@ -81,9 +97,6 @@ <h2>Quick Start</h2>
 
 app.listen(3000);
 </code></pre>
-<h2>More Examples</h2>
-<p>For more examples, please visit <a href="https://github.com/node-oauth/node-oauth2-server-examples">our dedicated &quot;examples&quot; repo</a>
-, which also contains express examples.</p>
 <h2>Options</h2>
 <blockquote>
 <p>Note: The following options <strong>extend</strong> the default options from <code>@node-oauth/oauth2-sever</code>!
@@ -112,8 +125,19 @@ <h2>Options</h2>
 <p><code>authenticate()</code> does not modify the response and will always call next()</p>
 </li>
 </ul>
+<h2>Migration notes</h2>
+<p>Beginning with <strong>version 4.0</strong> this package brings some potentially breaking changes:</p>
+<ul>
+<li>dropped old es5 code; moved to native async/await</li>
+<li>requires node &gt;= 16</li>
+<li>ships with <a href="https://github.com/node-oauth/node-oauth2-server">@node-oauth/oauth2-server</a> 5.x</li>
+<li>no express version pinned but declared as <code>'*'</code> peer dependency, so it should not cause conflicts with your express version</li>
+</ul>
+<h2>More Examples</h2>
+<p>For more examples, please visit <a href="https://github.com/node-oauth/node-oauth2-server-examples">our dedicated &quot;examples&quot; repo</a>
+, which also contains express examples.</p>
 <h2>License</h2>
-<p>MIT, see</p></article>
+<p>MIT, see <a href="./LICENSE">license file</a>.</p></article>
     </section>
 
 
@@ -130,7 +154,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ExpressOA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Jan 09 2024 09:13:55 GMT+0100 (Central European Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.3</a> on Wed Jul 31 2024 15:05:40 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/index.js.html

@@ -252,7 +252,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ExpressOA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Jan 09 2024 09:13:55 GMT+0100 (Central European Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.3</a> on Wed Jul 31 2024 15:05:40 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>