Skip to content

Commit 46cd8e1

Browse files
lbalmacedalbalmaceda
committed
Release v2.4.0
1 parent 06909eb commit 46cd8e1

14 files changed

+138
-94
lines changed

‎CHANGELOG.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Change Log
22

3+
## [v2.4.0](https://github.com/auth0/react-native-auth0/tree/v2.4.0) (2020-06-05)
4+
5+
[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.3.1...v2.4.0)
6+
7+
**Added**
8+
9+
- Added support for ephemeral sessions [SDK-1412][\#305](https://github.com/auth0/react-native-auth0/pull/305) ([Widcket](https://github.com/Widcket))
10+
11+
**Security**
12+
13+
- Bump dependencies in the lock file [\#313](https://github.com/auth0/react-native-auth0/pull/313) ([lbalmaceda](https://github.com/lbalmaceda))
14+
315
## [v2.3.1](https://github.com/auth0/react-native-auth0/tree/v2.3.1) (2020-04-29)
416

517
[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.3.0...v2.3.1)

‎docs/Auth.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2067,8 +2067,8 @@ <h5>Returns:</h5>
20672067
<br class="clear" />
20682068

20692069
<footer>
2070-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
2071-
Wed Apr 29 2020 17:09:02 GMT-0300 (Argentina Standard Time) using the
2070+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
2071+
Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
20722072
Minami theme.
20732073
</footer>
20742074

‎docs/Auth0.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,8 @@ <h3 class="subsection-title">Classes</h3>
229229
<br class="clear" />
230230

231231
<footer>
232-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
233-
Wed Apr 29 2020 17:09:02 GMT-0300 (Argentina Standard Time) using the
232+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
233+
Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
234234
Minami theme.
235235
</footer>
236236

‎docs/Auth0.module.exports.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,8 +294,8 @@ <h5>Parameters:</h5>
294294
<br class="clear" />
295295

296296
<footer>
297-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
298-
Wed Apr 29 2020 17:09:02 GMT-0300 (Argentina Standard Time) using the
297+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
298+
Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
299299
Minami theme.
300300
</footer>
301301

‎docs/Users.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -462,8 +462,8 @@ <h5>Returns:</h5>
462462
<br class="clear" />
463463

464464
<footer>
465-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
466-
Wed Apr 29 2020 17:09:02 GMT-0300 (Argentina Standard Time) using the
465+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
466+
Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
467467
Minami theme.
468468
</footer>
469469

‎docs/WebAuth.html‎

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ <h4 class="name" id=".authorize">
266266
<ul class="dummy">
267267
<li>
268268
<a href="src_webauth_index.js.html">src/webauth/index.js</a
269-
>, <a href="src_webauth_index.js.html#line58">line 58</a>
269+
>, <a href="src_webauth_index.js.html#line59">line 59</a>
270270
</li>
271271
</ul>
272272
</dd>
@@ -306,7 +306,7 @@ <h5>Parameters:</h5>
306306
</td>
307307

308308
<td class="description last">
309-
<p>parameters to send on the AuthN/AuthZ request.</p>
309+
<p>Parameters to send on the AuthN/AuthZ request.</p>
310310

311311
<table class="params">
312312
<thead>
@@ -333,7 +333,7 @@ <h5>Parameters:</h5>
333333

334334
<td class="description last">
335335
<p>
336-
random string to prevent CSRF attacks and used to
336+
Random string to prevent CSRF attacks and used to
337337
discard unexepcted results. By default its a
338338
cryptographically secure random.
339339
</p>
@@ -351,7 +351,7 @@ <h5>Parameters:</h5>
351351

352352
<td class="description last">
353353
<p>
354-
random string to prevent replay attacks of
354+
Random string to prevent replay attacks of
355355
id_tokens.
356356
</p>
357357
</td>
@@ -368,7 +368,7 @@ <h5>Parameters:</h5>
368368

369369
<td class="description last">
370370
<p>
371-
identifier of Resource Server (RS) to be included
371+
Identifier of Resource Server (RS) to be included
372372
as audience (aud claim) of the issued access token
373373
</p>
374374
</td>
@@ -385,7 +385,7 @@ <h5>Parameters:</h5>
385385

386386
<td class="description last">
387387
<p>
388-
scopes requested for the issued tokens. e.g.
388+
Scopes requested for the issued tokens. e.g.
389389
<code>openid profile</code>
390390
</p>
391391
</td>
@@ -439,7 +439,7 @@ <h5>Parameters:</h5>
439439
</td>
440440

441441
<td class="description last">
442-
<p>options for ID token validation configuration.</p>
442+
<p>Other configuration options.</p>
443443

444444
<table class="params">
445445
<thead>
@@ -472,6 +472,23 @@ <h5>Parameters:</h5>
472472
</p>
473473
</td>
474474
</tr>
475+
476+
<tr>
477+
<td class="name"><code>ephemeralSession</code></td>
478+
479+
<td class="type">
480+
<span class="param-type"><code>Boolean</code></span>
481+
</td>
482+
483+
<td class="attributes">&lt;optional><br /></td>
484+
485+
<td class="description last">
486+
<p>
487+
Disable Single-Sign-On (SSO). It only affects iOS
488+
with versions 13 and above.
489+
</p>
490+
</td>
491+
</tr>
475492
</tbody>
476493
</table>
477494
</td>
@@ -518,7 +535,7 @@ <h4 class="name" id=".clearSession">
518535
<ul class="dummy">
519536
<li>
520537
<a href="src_webauth_index.js.html">src/webauth/index.js</a
521-
>, <a href="src_webauth_index.js.html#line125">line 125</a>
538+
>, <a href="src_webauth_index.js.html#line128">line 128</a>
522539
</li>
523540
</ul>
524541
</dd>
@@ -557,7 +574,7 @@ <h5>Parameters:</h5>
557574
</td>
558575

559576
<td class="description last">
560-
<p>parameters to send</p>
577+
<p>Parameters to send</p>
561578

562579
<table class="params">
563580
<thead>
@@ -613,8 +630,8 @@ <h5>Returns:</h5>
613630
<br class="clear" />
614631

615632
<footer>
616-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
617-
Wed Apr 29 2020 17:09:02 GMT-0300 (Argentina Standard Time) using the
633+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
634+
Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
618635
Minami theme.
619636
</footer>
620637

‎docs/global.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,8 +268,8 @@ <h5>Returns:</h5>
268268
<br class="clear" />
269269

270270
<footer>
271-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
272-
Wed Apr 29 2020 17:09:01 GMT-0300 (Argentina Standard Time) using the
271+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
272+
Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
273273
Minami theme.
274274
</footer>
275275

‎docs/index.html‎

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -298,13 +298,13 @@ <h3>Compatibility Matrix</h3>
298298
</p>
299299
<h2>Getting Started</h2>
300300
<p>First install the native library module:</p>
301-
<p>Using <a href="https://www.npmjs.com">npm</a></p>
301+
<h3>With <a href="https://www.npmjs.com">npm</a></h3>
302302
<p><code>$ npm install react-native-auth0 --save</code></p>
303-
<p>or <a href="https://yarnpkg.com/en/">yarn</a></p>
303+
<h3>With <a href="https://yarnpkg.com/en/">Yarn</a></h3>
304304
<p><code>$ yarn add react-native-auth0</code></p>
305305
<p>
306306
Then, you need to run the following command to install the ios app
307-
pods with Cocoapods. That will auto-link the iOS library.
307+
pods with Cocoapods. That will auto-link the iOS library:
308308
</p>
309309
<p><code>$ cd ios &amp;&amp; pod install</code></p>
310310
<h3>Configuration</h3>
@@ -372,17 +372,17 @@ <h4>Android</h4>
372372
</p>
373373
<blockquote>
374374
<p>
375-
For more info please read
375+
For more info please read the
376376
<a
377377
href="https://facebook.github.io/react-native/docs/linking.html"
378-
>react native docs</a
379-
>
378+
>React Native docs</a
379+
>.
380380
</p>
381381
</blockquote>
382382
<h4>iOS</h4>
383383
<p>
384384
Inside the <code>ios</code> folder find the file
385-
<code>AppDelegate.[swift|m]</code> add the following to it
385+
<code>AppDelegate.[swift|m]</code> add the following to it:
386386
</p>
387387
<pre
388388
class="prettyprint source lang-objc"
@@ -408,7 +408,7 @@ <h4>iOS</h4>
408408
<p>
409409
and then below it register a URL type entry using the value of
410410
<code>CFBundleIdentifier</code> as the value for
411-
<code>CFBundleURLSchemes</code>
411+
<code>CFBundleURLSchemes</code>:
412412
</p>
413413
<pre
414414
class="prettyprint source lang-xml"
@@ -458,11 +458,11 @@ <h4>iOS</h4>
458458
</ul>
459459
<blockquote>
460460
<p>
461-
For more info please read
461+
For more info please read the
462462
<a
463463
href="https://facebook.github.io/react-native/docs/linking.html"
464-
>react native docs</a
465-
>
464+
>React Native docs</a
465+
>.
466466
</p>
467467
</blockquote>
468468
<h3>Callback URL(s)</h3>
@@ -550,13 +550,25 @@ <h2>Usage</h2>
550550
</p>
551551
</blockquote>
552552
<h3>Web Authentication</h3>
553-
<h4>Log in</h4>
553+
<h4>Login</h4>
554554
<pre class="prettyprint source lang-js"><code>auth0.webAuth
555555
.authorize({scope: 'openid email profile'})
556556
.then(credentials => console.log(credentials))
557557
.catch(error => console.log(error));
558558
</code></pre>
559-
<h4>Log out</h4>
559+
<h5>Disable Single Sign On (iOS 13+ only)</h5>
560+
<p>
561+
Use the <code>ephemeralSession</code> parameter to disable SSO on
562+
iOS 13+. This way iOS will not display the consent popup that
563+
otherwise shows up when SSO is enabled. It has no effect on older
564+
versions of iOS or Android.
565+
</p>
566+
<pre class="prettyprint source lang-js"><code>auth0.webAuth
567+
.authorize({scope: 'openid email profile'}, {ephemeralSession: true})
568+
.then(credentials => console.log(credentials))
569+
.catch(error => console.log(error));
570+
</code></pre>
571+
<h4>Logout</h4>
560572
<pre
561573
class="prettyprint source lang-js"
562574
><code>auth0.webAuth.clearSession().catch(error => console.log(error));
@@ -772,8 +784,8 @@ <h2>License</h2>
772784
<br class="clear" />
773785

774786
<footer>
775-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
776-
Wed Apr 29 2020 17:09:01 GMT-0300 (Argentina Standard Time) using the
787+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
788+
Fri Jun 05 2020 13:51:54 GMT-0300 (Argentina Standard Time) using the
777789
Minami theme.
778790
</footer>
779791

‎docs/index.js.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,8 @@ <h1 class="page-title">index.js</h1>
229229
<br class="clear" />
230230

231231
<footer>
232-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
233-
Wed Apr 29 2020 17:09:01 GMT-0300 (Argentina Standard Time) using the
232+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
233+
Fri Jun 05 2020 13:51:53 GMT-0300 (Argentina Standard Time) using the
234234
Minami theme.
235235
</footer>
236236

‎docs/src_auth_index.js.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -697,8 +697,8 @@ <h1 class="page-title">src/auth/index.js</h1>
697697
<br class="clear" />
698698

699699
<footer>
700-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
701-
Wed Apr 29 2020 17:09:01 GMT-0300 (Argentina Standard Time) using the
700+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on
701+
Fri Jun 05 2020 13:51:53 GMT-0300 (Argentina Standard Time) using the
702702
Minami theme.
703703
</footer>
704704

0 commit comments

Comments
 (0)