Release v4.0.0

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [v4.0.0](https://github.com/auth0/node-auth0/tree/v4.0.0) (2023-09-14)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v3.7.1...v4.0.0)
+
+This release brings a variety of exciting new features and improvements, including:
+
+- Rewritten from the ground up in TypeScript
+- Types for methods, request parameters, bodies, errors and responses
+- Customisable modern networking stack
+
+This release also drops support for Node <18. See the [Migration Guide](https://github.com/auth0/node-auth0/blob/master/v4_MIGRATION_GUIDE.md) for more information.
+
 ## [v4.0.0-beta.10](https://github.com/auth0/node-auth0/tree/v4.0.0-beta.10) (2023-09-12)
 
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v4.0.0-beta.9...v4.0.0-beta.10)

docs/classes/auth.AuthApiError.html

@@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AuthApiError</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/20d57660/src/auth/base-auth-api.ts#L32">src/auth/base-auth-api.ts:32</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/base-auth-api.ts#L32">src/auth/base-auth-api.ts:32</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -73,29 +73,29 @@ <h5><span class="tsd-kind-parameter">headers</span>: <span class="tsd-signature-
 <h4 class="tsd-returns-title">Returns <a href="auth.AuthApiError.html" class="tsd-signature-type tsd-kind-class">AuthApiError</a></h4><aside class="tsd-sources">
 <p>Overrides Error.constructor</p>
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/20d57660/src/auth/base-auth-api.ts#L34">src/auth/base-auth-api.ts:34</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/base-auth-api.ts#L34">src/auth/base-auth-api.ts:34</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="body" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>body</span><a href="#body" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">body</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/node-auth0/blob/20d57660/src/auth/base-auth-api.ts#L38">src/auth/base-auth-api.ts:38</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/base-auth-api.ts#L38">src/auth/base-auth-api.ts:38</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="error" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">error</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/node-auth0/blob/20d57660/src/auth/base-auth-api.ts#L35">src/auth/base-auth-api.ts:35</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/base-auth-api.ts#L35">src/auth/base-auth-api.ts:35</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="error_description" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>error_<wbr/>description</span><a href="#error_description" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">error_<wbr/>description</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/node-auth0/blob/20d57660/src/auth/base-auth-api.ts#L36">src/auth/base-auth-api.ts:36</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/base-auth-api.ts#L36">src/auth/base-auth-api.ts:36</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="headers" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>headers</span><a href="#headers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">headers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Headers</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/20d57660/src/auth/base-auth-api.ts#L39">src/auth/base-auth-api.ts:39</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/base-auth-api.ts#L39">src/auth/base-auth-api.ts:39</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -107,7 +107,7 @@ <h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permali
 <div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;AuthApiError&quot;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <p>Overrides Error.name</p>
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/20d57660/src/auth/base-auth-api.ts#L33">src/auth/base-auth-api.ts:33</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/base-auth-api.ts#L33">src/auth/base-auth-api.ts:33</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -118,7 +118,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <h3 class="tsd-anchor-link"><span>status<wbr/>Code</span><a href="#statusCode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">status<wbr/>Code</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/node-auth0/blob/20d57660/src/auth/base-auth-api.ts#L37">src/auth/base-auth-api.ts:37</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/base-auth-api.ts#L37">src/auth/base-auth-api.ts:37</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>

docs/classes/auth.AuthenticationClient.html

@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">AuthenticationClient</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/20d57660/src/auth/index.ts#L12">src/auth/index.ts:12</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/index.ts#L12">src/auth/index.ts:12</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -51,24 +51,24 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/auth.AuthenticationClientOptions.html" class="tsd-signature-type tsd-kind-interface">AuthenticationClientOptions</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="auth.AuthenticationClient.html" class="tsd-signature-type tsd-kind-class">AuthenticationClient</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/20d57660/src/auth/index.ts#L17">src/auth/index.ts:17</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/index.ts#L17">src/auth/index.ts:17</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="database" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>database</span><a href="#database" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">database</span><span class="tsd-signature-symbol">:</span> <a href="auth.Database.html" class="tsd-signature-type tsd-kind-class">Database</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/20d57660/src/auth/index.ts#L13">src/auth/index.ts:13</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/index.ts#L13">src/auth/index.ts:13</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="oauth" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>oauth</span><a href="#oauth" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">oauth</span><span class="tsd-signature-symbol">:</span> <a href="auth.OAuth.html" class="tsd-signature-type tsd-kind-class">OAuth</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/20d57660/src/auth/index.ts#L14">src/auth/index.ts:14</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/index.ts#L14">src/auth/index.ts:14</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="passwordless" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>passwordless</span><a href="#passwordless" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">passwordless</span><span class="tsd-signature-symbol">:</span> <a href="auth.Passwordless.html" class="tsd-signature-type tsd-kind-class">Passwordless</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/20d57660/src/auth/index.ts#L15">src/auth/index.ts:15</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/56614a49/src/auth/index.ts#L15">src/auth/index.ts:15</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">