Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v4.2.0 #974

Merged
merged 1 commit into from
Dec 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Change Log

## [v4.2.0](https://github.com/auth0/node-auth0/tree/v4.2.0) (2023-12-07)

[Full Changelog](https://github.com/auth0/node-auth0/compare/v4.1.0...v4.2.0)

**Added**

- Add support for Pushed Authorization Requests [\#973](https://github.com/auth0/node-auth0/pull/973) ([frederikprijck](https://github.com/frederikprijck))

## [v4.1.0](https://github.com/auth0/node-auth0/tree/v4.1.0) (2023-10-30)

[Full Changelog](https://github.com/auth0/node-auth0/compare/v4.0.2...v4.1.0)
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

18 changes: 10 additions & 8 deletions docs/classes/auth.AuthApiError.html
Original file line number Diff line number Diff line change
Expand Up @@ -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/5f184fc0/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/4d43370e/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">
Expand Down Expand Up @@ -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/5f184fc0/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/4d43370e/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/5f184fc0/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/4d43370e/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/5f184fc0/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/4d43370e/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/5f184fc0/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/4d43370e/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/5f184fc0/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/4d43370e/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">
Expand All @@ -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/5f184fc0/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/4d43370e/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">
Expand All @@ -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/5f184fc0/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/4d43370e/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>
Expand Down Expand Up @@ -238,6 +238,8 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li><a href="../interfaces/auth.LoginWithEmailRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Login<wbr/>With<wbr/>Email<wbr/>Request</span></a></li>
<li><a href="../interfaces/auth.LoginWithSMSRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Login<wbr/>WithSMSRequest</span></a></li>
<li><a href="../interfaces/auth.PasswordGrantRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Password<wbr/>Grant<wbr/>Request</span></a></li>
<li><a href="../interfaces/auth.PushedAuthorizationRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Pushed<wbr/>Authorization<wbr/>Request</span></a></li>
<li><a href="../interfaces/auth.PushedAuthorizationResponse.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Pushed<wbr/>Authorization<wbr/>Response</span></a></li>
<li><a href="../interfaces/auth.RefreshTokenGrantRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Refresh<wbr/>Token<wbr/>Grant<wbr/>Request</span></a></li>
<li><a href="../interfaces/auth.RevokeRefreshTokenRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Revoke<wbr/>Refresh<wbr/>Token<wbr/>Request</span></a></li>
<li><a href="../interfaces/auth.SendEmailCodeRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Send<wbr/>Email<wbr/>Code<wbr/>Request</span></a></li>
Expand Down
12 changes: 7 additions & 5 deletions docs/classes/auth.AuthenticationClient.html
Original file line number Diff line number Diff line change
Expand Up @@ -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/5f184fc0/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/4d43370e/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">
Expand Down Expand Up @@ -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/5f184fc0/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/4d43370e/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/5f184fc0/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/4d43370e/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/5f184fc0/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/4d43370e/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/5f184fc0/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/4d43370e/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">
Expand Down Expand Up @@ -129,6 +129,8 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li><a href="../interfaces/auth.LoginWithEmailRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Login<wbr/>With<wbr/>Email<wbr/>Request</span></a></li>
<li><a href="../interfaces/auth.LoginWithSMSRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Login<wbr/>WithSMSRequest</span></a></li>
<li><a href="../interfaces/auth.PasswordGrantRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Password<wbr/>Grant<wbr/>Request</span></a></li>
<li><a href="../interfaces/auth.PushedAuthorizationRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Pushed<wbr/>Authorization<wbr/>Request</span></a></li>
<li><a href="../interfaces/auth.PushedAuthorizationResponse.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Pushed<wbr/>Authorization<wbr/>Response</span></a></li>
<li><a href="../interfaces/auth.RefreshTokenGrantRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Refresh<wbr/>Token<wbr/>Grant<wbr/>Request</span></a></li>
<li><a href="../interfaces/auth.RevokeRefreshTokenRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Revoke<wbr/>Refresh<wbr/>Token<wbr/>Request</span></a></li>
<li><a href="../interfaces/auth.SendEmailCodeRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Send<wbr/>Email<wbr/>Code<wbr/>Request</span></a></li>
Expand Down
Loading