Release v2.9.0

auth0 · Jun 22, 2021 · df8862f · df8862f
1 parent b991985
commit df8862f
Show file tree

Hide file tree

Showing 14 changed files with 68 additions and 67 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Change Log
 
+## [v2.9.0](https://github.com/auth0/react-native-auth0/tree/v2.9.0) (2021-06-22)
+
+[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.8.3...v2.9.0)
+
+**Breaking changes**
+
+- Fixed authentication restart when the app is minimized [SDK-2199][\#350](https://github.com/auth0/react-native-auth0/pull/350) ([Widcket](https://github.com/Widcket))
+
 ## [v2.8.3](https://github.com/auth0/react-native-auth0/tree/v2.8.3) (2021-05-05)
 
 [Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.8.2...v2.8.3)

diff --git a/docs/Auth.html b/docs/Auth.html
@@ -2068,7 +2068,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/Auth0.html b/docs/Auth0.html
@@ -230,7 +230,7 @@ <h3 class="subsection-title">Classes</h3>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/Auth0.module.exports.html b/docs/Auth0.module.exports.html
@@ -295,7 +295,7 @@ <h5>Parameters:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/Users.html b/docs/Users.html
@@ -463,7 +463,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/WebAuth.html b/docs/WebAuth.html
@@ -691,7 +691,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/global.html b/docs/global.html
@@ -269,7 +269,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/index.html b/docs/index.html
@@ -189,7 +189,7 @@ <h1>react-native-auth0</h1>
           <p>
             <a href="https://circleci.com/gh/auth0/react-native-auth0"
               ><img
-                src="http://img.shields.io/circleci/project/github/auth0/react-native-auth0.svg?branch=master&amp;style=flat-square"
+                src="https://img.shields.io/circleci/project/github/auth0/react-native-auth0.svg?branch=master&amp;style=flat-square"
                 alt="Build Status"
             /></a>
             <a href="https://npmjs.org/package/react-native-auth0"
@@ -204,12 +204,12 @@ <h1>react-native-auth0</h1>
             /></a>
             <a href="#license"
               ><img
-                src="http://img.shields.io/npm/l/react-native-auth0.svg?style=flat-square"
+                src="https://img.shields.io/npm/l/react-native-auth0.svg?style=flat-square"
                 alt="License"
             /></a>
             <a href="https://npmjs.org/package/react-native-auth0"
               ><img
-                src="http://img.shields.io/npm/dm/react-native-auth0.svg?style=flat-square"
+                src="https://img.shields.io/npm/dm/react-native-auth0.svg?style=flat-square"
                 alt="Downloads"
             /></a>
             <a
@@ -219,6 +219,18 @@ <h1>react-native-auth0</h1>
                 alt="FOSSA Status"
             /></a>
           </p>
+          <h2>Important Notices</h2>
+          <p>
+            Version <strong>2.9.0</strong> introduced a
+            <strong>breaking change</strong> to the Android configuration.
+            Previously it was required to add an intent filter in the definition
+            of the Activity that receives the authentication result, and to use
+            the <code>singleTask</code> <strong>launchMode</strong> in that
+            activity. Now both the intent filter and the launch mode must be
+            removed and instead you need to add a couple of manifest
+            placeholders. Check out the <a href="#android">Android</a> section
+            for more details.
+          </p>
           <h2>Table of Contents</h2>
           <ul>
             <li><a href="#documentation">Documentation</a></li>
@@ -326,51 +338,40 @@ <h3>Configuration</h3>
             platform has its own set of instructions.
           </p>
           <h4>Android</h4>
+          <blockquote>
+            <p>
+              Before version 2.9.0, this SDK required you to add an intent
+              filter to the Activity on which you're going to receive the
+              authentication result, and to use the <code>singleTask</code>
+              <strong>launchMode</strong> in that activity. To migrate your app
+              to version 2.9.0+, remove both and continue with the instructions
+              below.
+            </p>
+          </blockquote>
           <p>
-            Open the <code>AndroidManifest.xml</code> file of your application
-            typically at
-            <code>android/app/src/main/AndroidManifest.xml</code> and
-            <strong>make sure</strong> the Activity on which you're going to
-            receive the authentication result has a
-            <strong>launchMode</strong> of <code>singleTask</code>. Additionally
-            inside this Activity definition include the following intent filter.
-          </p>
-          <pre class="prettyprint source lang-xml"><code>&lt;intent-filter>
-    &lt;action android:name=&quot;android.intent.action.VIEW&quot; />
-    &lt;category android:name=&quot;android.intent.category.DEFAULT&quot; />
-    &lt;category android:name=&quot;android.intent.category.BROWSABLE&quot; />
-    &lt;data
-        android:host=&quot;YOUR_AUTH0_DOMAIN&quot;
-        android:pathPrefix=&quot;/android/${applicationId}/callback&quot;
-        android:scheme=&quot;${applicationId}&quot; />
-&lt;/intent-filter>
+            Open your app's <code>build.gradle</code> file (typically at
+            <code>android/app/build.gradle</code>) and add the following
+            manifest placeholders:
+          </p>
+          <pre class="prettyprint source lang-groovy"><code>android {
+    defaultConfig {
+        // Add the next line
+        manifestPlaceholders = [auth0Domain: &quot;YOUR_AUTH0_DOMAIN&quot;, auth0Scheme: &quot;${applicationId}&quot;]
+    }
+    ...
+}
 </code></pre>
           <p>
-            The <code>android:host</code> value must be replaced with your Auth0
+            The <code>auth0Domain</code> value must be replaced with your Auth0
             domain value. So if you have <code>samples.auth0.com</code> as your
-            Auth0 domain you would have the following
-            <strong>MainActivity</strong> configuration:
-          </p>
-          <pre class="prettyprint source lang-xml"><code>&lt;activity
-android:name=&quot;.MainActivity&quot;
-android:label=&quot;@string/app_name&quot;
-android:launchMode=&quot;singleTask&quot;
-android:configChanges=&quot;keyboard|keyboardHidden|orientation|screenSize&quot;
-android:windowSoftInputMode=&quot;adjustResize&quot;>
-&lt;intent-filter>
-    &lt;action android:name=&quot;android.intent.action.MAIN&quot; />
-    &lt;category android:name=&quot;android.intent.category.LAUNCHER&quot; />
-&lt;/intent-filter>
-&lt;intent-filter>
-    &lt;action android:name=&quot;android.intent.action.VIEW&quot; />
-    &lt;category android:name=&quot;android.intent.category.DEFAULT&quot; />
-    &lt;category android:name=&quot;android.intent.category.BROWSABLE&quot; />
-    &lt;data
-        android:host=&quot;samples.auth0.com&quot;
-        android:pathPrefix=&quot;/android/${applicationId}/callback&quot;
-        android:scheme=&quot;${applicationId}&quot; />
-&lt;/intent-filter>
-&lt;/activity>
+            Auth0 domain you would have a configuration like the following:
+          </p>
+          <pre class="prettyprint source lang-groovy"><code>android {
+    defaultConfig {
+        manifestPlaceholders = [auth0Domain: &quot;samples.auth0.com&quot;, auth0Scheme: &quot;${applicationId}&quot;]
+    }
+    ...
+}
 </code></pre>
           <p>
             The <code>applicationId</code> value will be auto-replaced on
@@ -381,7 +382,7 @@ <h4>Android</h4>
           </p>
           <p>
             If you use a value other than <code>applicationId</code> in
-            <code>android:scheme</code> you will also need to pass it as the
+            <code>auth0Scheme</code> you will also need to pass it as the
             <code>customScheme</code> option parameter of the
             <code>authorize</code> and <code>clearSession</code> methods.
           </p>
@@ -735,7 +736,7 @@ <h3>Get full user profile</h3>
 </code></pre>
           <p>
             For more info please check our generated
-            <a href="http://auth0.github.io/react-native-auth0/index.html"
+            <a href="https://auth0.github.io/react-native-auth0/index.html"
               >documentation</a
             >
           </p>
@@ -970,14 +971,6 @@ <h2>License</h2>
             <a href="LICENSE">LICENSE</a> file for more info.
           </p>
           <!-- Variables -->
-          <p>
-            <a
-              href="https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Freact-native-auth0?ref=badge_large"
-              ><img
-                src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Freact-native-auth0.svg?type=large"
-                alt="FOSSA Status"
-            /></a>
-          </p>
         </article>
       </section>
     </div>
@@ -986,7 +979,7 @@ <h2>License</h2>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -230,7 +230,7 @@ <h1 class="page-title">index.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/src_auth_index.js.html b/docs/src_auth_index.js.html
@@ -698,7 +698,7 @@ <h1 class="page-title">src/auth/index.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/src_management_users.js.html b/docs/src_management_users.js.html
@@ -298,7 +298,7 @@ <h1 class="page-title">src/management/users.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/src_webauth_index.js.html b/docs/src_webauth_index.js.html
@@ -357,7 +357,7 @@ <h1 class="page-title">src/webauth/index.js</h1>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on
-      Wed May 05 2021 13:08:51 GMT-0300 (Argentina Standard Time) using the
+      Tue Jun 22 2021 14:24:13 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "react-native-auth0",
   "title": "React Native Auth0",
-  "version": "2.8.3",
+  "version": "2.9.0",
   "description": "React Native toolkit for Auth0 API",
   "main": "index.js",
   "scripts": {

diff --git a/src/networking/telemetry.js b/src/networking/telemetry.js
@@ -1 +1 @@
-module.exports = {name: 'react-native-auth0', version: '2.8.3'};
+module.exports = {name: 'react-native-auth0', version: '2.9.0'};
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		module.exports = {name: 'react-native-auth0', version: '2.8.3'};
		module.exports = {name: 'react-native-auth0', version: '2.9.0'};