Skip to content

Commit 194db88

Browse files
authored
Merge pull request #47 from auth0/release/v1.1.0
Release v1.1.0
2 parents 0b65192 + eb5d987 commit 194db88

File tree

9 files changed

+154
-43
lines changed

9 files changed

+154
-43
lines changed

docs/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/index.html

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@ <h1>express-oauth2-jwt-bearer</h1>
6161
<h2>Index</h2>
6262
<section class="tsd-panel tsd-index-panel">
6363
<div class="tsd-index-content">
64+
<section class="tsd-index-section ">
65+
<h3>Classes</h3>
66+
<ul class="tsd-index-list">
67+
<li class="tsd-kind-class"><a href="classes/insufficientscopeerror.html" class="tsd-kind-icon">Insufficient<wbr>Scope<wbr>Error</a></li>
68+
<li class="tsd-kind-class"><a href="classes/invalidrequesterror.html" class="tsd-kind-icon">Invalid<wbr>Request<wbr>Error</a></li>
69+
<li class="tsd-kind-class"><a href="classes/invalidtokenerror.html" class="tsd-kind-icon">Invalid<wbr>Token<wbr>Error</a></li>
70+
<li class="tsd-kind-class"><a href="classes/unauthorizederror.html" class="tsd-kind-icon">Unauthorized<wbr>Error</a></li>
71+
</ul>
72+
</section>
6473
<section class="tsd-index-section ">
6574
<h3>Interfaces</h3>
6675
<ul class="tsd-index-list">
@@ -97,7 +106,7 @@ <h3>JSONPrimitive</h3>
97106
<div class="tsd-signature tsd-kind-icon">JSONPrimitive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
98107
<aside class="tsd-sources">
99108
<ul>
100-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/claim-check.ts#L8">packages/access-token-jwt/src/claim-check.ts:8</a></li>
109+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/claim-check.ts#L8">packages/access-token-jwt/src/claim-check.ts:8</a></li>
101110
</ul>
102111
</aside>
103112
</section>
@@ -114,7 +123,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> auth</h3>
114123
<li class="tsd-description">
115124
<aside class="tsd-sources">
116125
<ul>
117-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/express-oauth2-jwt-bearer/src/index.ts#L62">packages/express-oauth2-jwt-bearer/src/index.ts:62</a></li>
126+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/express-oauth2-jwt-bearer/src/index.ts#L62">packages/express-oauth2-jwt-bearer/src/index.ts:62</a></li>
118127
</ul>
119128
</aside>
120129
<div class="tsd-comment tsd-typography">
@@ -169,7 +178,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> claim<wbr>Check</h3>
169178
<li class="tsd-description">
170179
<aside class="tsd-sources">
171180
<ul>
172-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/express-oauth2-jwt-bearer/src/index.ts#L108">packages/express-oauth2-jwt-bearer/src/index.ts:108</a></li>
181+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/express-oauth2-jwt-bearer/src/index.ts#L106">packages/express-oauth2-jwt-bearer/src/index.ts:106</a></li>
173182
</ul>
174183
</aside>
175184
<div class="tsd-comment tsd-typography">
@@ -227,7 +236,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> claim<wbr>Equals</h3>
227236
<li class="tsd-description">
228237
<aside class="tsd-sources">
229238
<ul>
230-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/express-oauth2-jwt-bearer/src/index.ts#L122">packages/express-oauth2-jwt-bearer/src/index.ts:122</a></li>
239+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/express-oauth2-jwt-bearer/src/index.ts#L120">packages/express-oauth2-jwt-bearer/src/index.ts:120</a></li>
231240
</ul>
232241
</aside>
233242
<div class="tsd-comment tsd-typography">
@@ -264,7 +273,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> claim<wbr>Includes</h3>
264273
<li class="tsd-description">
265274
<aside class="tsd-sources">
266275
<ul>
267-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/express-oauth2-jwt-bearer/src/index.ts#L137">packages/express-oauth2-jwt-bearer/src/index.ts:137</a></li>
276+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/express-oauth2-jwt-bearer/src/index.ts#L135">packages/express-oauth2-jwt-bearer/src/index.ts:135</a></li>
268277
</ul>
269278
</aside>
270279
<div class="tsd-comment tsd-typography">
@@ -302,7 +311,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> required<wbr>Scopes</h3>
302311
<li class="tsd-description">
303312
<aside class="tsd-sources">
304313
<ul>
305-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/express-oauth2-jwt-bearer/src/index.ts#L152">packages/express-oauth2-jwt-bearer/src/index.ts:152</a></li>
314+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/express-oauth2-jwt-bearer/src/index.ts#L150">packages/express-oauth2-jwt-bearer/src/index.ts:150</a></li>
306315
</ul>
307316
</aside>
308317
<div class="tsd-comment tsd-typography">
@@ -339,6 +348,18 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Handler</
339348
</nav>
340349
<nav class="tsd-navigation secondary menu-sticky">
341350
<ul class="before-current">
351+
<li class=" tsd-kind-class">
352+
<a href="classes/insufficientscopeerror.html" class="tsd-kind-icon">Insufficient<wbr>Scope<wbr>Error</a>
353+
</li>
354+
<li class=" tsd-kind-class">
355+
<a href="classes/invalidrequesterror.html" class="tsd-kind-icon">Invalid<wbr>Request<wbr>Error</a>
356+
</li>
357+
<li class=" tsd-kind-class">
358+
<a href="classes/invalidtokenerror.html" class="tsd-kind-icon">Invalid<wbr>Token<wbr>Error</a>
359+
</li>
360+
<li class=" tsd-kind-class">
361+
<a href="classes/unauthorizederror.html" class="tsd-kind-icon">Unauthorized<wbr>Error</a>
362+
</li>
342363
<li class=" tsd-kind-interface">
343364
<a href="interfaces/authoptions.html" class="tsd-kind-icon">Auth<wbr>Options</a>
344365
</li>
@@ -378,9 +399,16 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Handler</
378399
<div class="container">
379400
<h2>Legend</h2>
380401
<div class="tsd-legend-group">
402+
<ul class="tsd-legend">
403+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
404+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
405+
</ul>
381406
<ul class="tsd-legend">
382407
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
383408
</ul>
409+
<ul class="tsd-legend">
410+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
411+
</ul>
384412
</div>
385413
</div>
386414
</footer>

docs/interfaces/authoptions.html

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> agent</h3>
106106
<div class="tsd-signature tsd-kind-icon">agent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Agent</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Agent</span></div>
107107
<aside class="tsd-sources">
108108
<ul>
109-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L50">packages/access-token-jwt/src/jwt-verifier.ts:50</a></li>
109+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L50">packages/access-token-jwt/src/jwt-verifier.ts:50</a></li>
110110
</ul>
111111
</aside>
112112
<div class="tsd-comment tsd-typography">
@@ -122,7 +122,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> audience</h3>
122122
<div class="tsd-signature tsd-kind-icon">audience<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
123123
<aside class="tsd-sources">
124124
<ul>
125-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L29">packages/access-token-jwt/src/jwt-verifier.ts:29</a></li>
125+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L29">packages/access-token-jwt/src/jwt-verifier.ts:29</a></li>
126126
</ul>
127127
</aside>
128128
<div class="tsd-comment tsd-typography">
@@ -138,7 +138,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> clock<wbr>Tolerance</
138138
<div class="tsd-signature tsd-kind-icon">clock<wbr>Tolerance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
139139
<aside class="tsd-sources">
140140
<ul>
141-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L93">packages/access-token-jwt/src/jwt-verifier.ts:93</a></li>
141+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L93">packages/access-token-jwt/src/jwt-verifier.ts:93</a></li>
142142
</ul>
143143
</aside>
144144
<div class="tsd-comment tsd-typography">
@@ -154,7 +154,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> cooldown<wbr>Duration
154154
<div class="tsd-signature tsd-kind-icon">cooldown<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
155155
<aside class="tsd-sources">
156156
<ul>
157-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L57">packages/access-token-jwt/src/jwt-verifier.ts:57</a></li>
157+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L57">packages/access-token-jwt/src/jwt-verifier.ts:57</a></li>
158158
</ul>
159159
</aside>
160160
<div class="tsd-comment tsd-typography">
@@ -171,7 +171,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> issuer</h3>
171171
<div class="tsd-signature tsd-kind-icon">issuer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
172172
<aside class="tsd-sources">
173173
<ul>
174-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L36">packages/access-token-jwt/src/jwt-verifier.ts:36</a></li>
174+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L36">packages/access-token-jwt/src/jwt-verifier.ts:36</a></li>
175175
</ul>
176176
</aside>
177177
<div class="tsd-comment tsd-typography">
@@ -188,7 +188,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> issuer<wbr>BaseURL</h
188188
<div class="tsd-signature tsd-kind-icon">issuer<wbr>BaseURL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
189189
<aside class="tsd-sources">
190190
<ul>
191-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L23">packages/access-token-jwt/src/jwt-verifier.ts:23</a></li>
191+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L23">packages/access-token-jwt/src/jwt-verifier.ts:23</a></li>
192192
</ul>
193193
</aside>
194194
<div class="tsd-comment tsd-typography">
@@ -209,7 +209,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> jwks<wbr>Uri</h3>
209209
<div class="tsd-signature tsd-kind-icon">jwks<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
210210
<aside class="tsd-sources">
211211
<ul>
212-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L44">packages/access-token-jwt/src/jwt-verifier.ts:44</a></li>
212+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L44">packages/access-token-jwt/src/jwt-verifier.ts:44</a></li>
213213
</ul>
214214
</aside>
215215
<div class="tsd-comment tsd-typography">
@@ -227,7 +227,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Token<wbr>Age
227227
<div class="tsd-signature tsd-kind-icon">max<wbr>Token<wbr>Age<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
228228
<aside class="tsd-sources">
229229
<ul>
230-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L99">packages/access-token-jwt/src/jwt-verifier.ts:99</a></li>
230+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L99">packages/access-token-jwt/src/jwt-verifier.ts:99</a></li>
231231
</ul>
232232
</aside>
233233
<div class="tsd-comment tsd-typography">
@@ -243,7 +243,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> secret</h3>
243243
<div class="tsd-signature tsd-kind-icon">secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
244244
<aside class="tsd-sources">
245245
<ul>
246-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L113">packages/access-token-jwt/src/jwt-verifier.ts:113</a></li>
246+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L113">packages/access-token-jwt/src/jwt-verifier.ts:113</a></li>
247247
</ul>
248248
</aside>
249249
<div class="tsd-comment tsd-typography">
@@ -259,7 +259,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3>
259259
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
260260
<aside class="tsd-sources">
261261
<ul>
262-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L107">packages/access-token-jwt/src/jwt-verifier.ts:107</a></li>
262+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L107">packages/access-token-jwt/src/jwt-verifier.ts:107</a></li>
263263
</ul>
264264
</aside>
265265
<div class="tsd-comment tsd-typography">
@@ -277,7 +277,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> timeout<wbr>Duration<
277277
<div class="tsd-signature tsd-kind-icon">timeout<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
278278
<aside class="tsd-sources">
279279
<ul>
280-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L64">packages/access-token-jwt/src/jwt-verifier.ts:64</a></li>
280+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L64">packages/access-token-jwt/src/jwt-verifier.ts:64</a></li>
281281
</ul>
282282
</aside>
283283
<div class="tsd-comment tsd-typography">
@@ -294,7 +294,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> token<wbr>Signing<wbr
294294
<div class="tsd-signature tsd-kind-icon">token<wbr>Signing<wbr>Alg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
295295
<aside class="tsd-sources">
296296
<ul>
297-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L122">packages/access-token-jwt/src/jwt-verifier.ts:122</a></li>
297+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L122">packages/access-token-jwt/src/jwt-verifier.ts:122</a></li>
298298
</ul>
299299
</aside>
300300
<div class="tsd-comment tsd-typography">
@@ -313,7 +313,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> validators</h3>
313313
<div class="tsd-signature tsd-kind-icon">validators<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Validators</span><span class="tsd-signature-symbol">&gt;</span></div>
314314
<aside class="tsd-sources">
315315
<ul>
316-
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/e7e9d42/packages/access-token-jwt/src/jwt-verifier.ts#L87">packages/access-token-jwt/src/jwt-verifier.ts:87</a></li>
316+
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/0b65192/packages/access-token-jwt/src/jwt-verifier.ts#L87">packages/access-token-jwt/src/jwt-verifier.ts:87</a></li>
317317
</ul>
318318
</aside>
319319
<div class="tsd-comment tsd-typography">
@@ -350,6 +350,18 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> validators</h3>
350350
</nav>
351351
<nav class="tsd-navigation secondary menu-sticky">
352352
<ul class="before-current">
353+
<li class=" tsd-kind-class">
354+
<a href="../classes/insufficientscopeerror.html" class="tsd-kind-icon">Insufficient<wbr>Scope<wbr>Error</a>
355+
</li>
356+
<li class=" tsd-kind-class">
357+
<a href="../classes/invalidrequesterror.html" class="tsd-kind-icon">Invalid<wbr>Request<wbr>Error</a>
358+
</li>
359+
<li class=" tsd-kind-class">
360+
<a href="../classes/invalidtokenerror.html" class="tsd-kind-icon">Invalid<wbr>Token<wbr>Error</a>
361+
</li>
362+
<li class=" tsd-kind-class">
363+
<a href="../classes/unauthorizederror.html" class="tsd-kind-icon">Unauthorized<wbr>Error</a>
364+
</li>
353365
</ul>
354366
<ul class="current">
355367
<li class="current tsd-kind-interface">
@@ -434,9 +446,16 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> validators</h3>
434446
<div class="container">
435447
<h2>Legend</h2>
436448
<div class="tsd-legend-group">
449+
<ul class="tsd-legend">
450+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
451+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
452+
</ul>
437453
<ul class="tsd-legend">
438454
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
439455
</ul>
456+
<ul class="tsd-legend">
457+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
458+
</ul>
440459
</div>
441460
</div>
442461
</footer>

0 commit comments

Comments
 (0)