Update documentation & address code review comments

Author: Kadi Kraman

.babelrc

@@ -1,3 +1,3 @@
 {
-  "presets": ["es2015"]
+  "presets": ["babel-preset-react-native"]
 }

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013
+Copyright (c) 2017 Formidable Labs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -1,33 +1,41 @@
-# react-native-app-auth
+# React Native App Auth
 
 React Native bridge for ![AppAuth-iOS](https://github.com/openid/AppAuth-iOS) and ![AppAuth-Android](https://github.com/openid/AppAuth-Android) - an SDK for communicating with OAuth2 providers. It also supports the PKCE extension to OAuth.
 
-In theory, the library should support any OAuth provider that implements the ![OAuth2 spec](https://tools.ietf.org/html/rfc6749#section-2.2) and it has been tested with:
+This library *should* support any OAuth provider that implements the ![OAuth2 spec](https://tools.ietf.org/html/rfc6749#section-2.2) but it has only been tested with:
 
 - ![Identity Server4](https://demo.identityserver.io/)
 - ![Google](https://developers.google.com/identity/protocols/OAuth2)
 
-Supported methods:
+The library uses auto-discovery which mean it relies on the the ![.well-known/openid-configuration](https://openid.net/specs/openid-connect-discovery-1_0.html) endpoint to discover all auth endpoints automatically. It will be possible to extend the library later to add custom configuration.
 
-### authorize()
+# Supported methods:
+
+### authorize
+This is the main function to use for authentication. Evoking this function will do the whole login flow and returns the access token, refresh token and access token expiry date when successful, or it throws an error when not successful.
 ```
-await AppAuth.authorize(scopes);
+import AppAuth from 'react-native-app-auth';
+
+const appAuth = new AppAuth(config);
+const result = await AppAuth.authorize(scopes);
 // returns accessToken, accessTokenExpirationDate and refreshToken
 ```
 
-### refresh()
+### refresh
+This method will refresh the accessToken using the refreshToken. Some auth providers will also give you a new refreshToken
 ```
 await AppAuth.refresh(refreshToken, scopes);
-// returns accessTokenExpirationDate
+// returns accessToken, accessTokenExpirationDate and  (maybe) refreshToken
 ```
 
-### revokeToken()
+### revokeToken
+This method will revoke a token. The tokenToRevoke can be either an accessToken or a refreshToken
 ```
 // note, sendClientId=true will only be required when using IdentityServer
 await AppAuth.revokeToken(tokenToRevoke, sendClientId);
 ```
 
-## Getting started
+# Getting started
 
 `$ npm install react-native-app-auth --save`
 
@@ -123,7 +131,7 @@ manifestPlaceholders = [
 
 
 
-## Usage
+# Usage
 ```javascript
 import AppAuth from 'react-native-app-auth';
 
@@ -132,8 +140,6 @@ const appAuth = new AppAuth({
   issuer: '<YOUR_ISSUER_URL>',
   clientId: '<YOUR_CLIENT_ID',
   redirectUrl: '<YOUR_REDIRECT_URL>',
-  revokeTokenUrl: '<YOUR_REVOKE_TOKEN_URL>',
-  allowOfflineAccess: true,
 });
 
 // use the client to make the auth request and receive the authState
@@ -146,12 +152,12 @@ try {
 }
 ```
 
-## Support
+# Support
 
-### Identity Server 4
+## Identity Server 4
 This library supports authenticating for Identity Server 4 out of the box. Some quirks:
 1. In order to enable `offline_access`, it must be passed in as a scope variable
 2. In order to revoke the access token, must sent client id in the method body of the request. This is not part of the OAuth spec.
 
-### Google
+## Google
 Full support out of the box

index.js

@@ -17,8 +17,7 @@ export default class AppAuth {
   }
 
   authorize(scopes) {
-    invariant(scopes, 'Scope error: please add at least one scope');
-    invariant(scopes.length, 'Scope error: please add at least one scope');
+    invariant(scopes && scopes.length, 'Scope error: please add at least one scope');
 
     return RNAppAuth.authorize(
       this.config.issuer,
@@ -30,8 +29,7 @@ export default class AppAuth {
 
   refresh(refreshToken, scopes) {
     invariant(refreshToken, 'Please pass in a refresh token');
-    invariant(scopes, 'Scope error: please add at least one scope');
-    invariant(scopes.length, 'Scope error: please add at least one scope');
+    invariant(scopes && scopes.length, 'Scope error: please add at least one scope');
 
     return RNAppAuth.refresh(
       this.config.issuer,
@@ -43,7 +41,7 @@ export default class AppAuth {
   }
 
   async revokeToken(tokenToRevoke, sendClientId = false) {
-    invariant(tokenToRevoke, 'Plese include the token to revoke');
+    invariant(tokenToRevoke, 'Please include the token to revoke');
 
     const response = await fetch(`${this.config.issuer}/.well-known/openid-configuration`);
     const openidConfig = await response.json();
@@ -65,7 +63,7 @@ export default class AppAuth {
       headers: {
         'Content-Type': 'application/x-www-form-urlencoded'
       },
-      body: `token=${tokenToRevoke}${sendClientId ? `client_id=${this.config.clientId}` : ''}`
+      body: `token=${tokenToRevoke}${sendClientId ? `&client_id=${this.config.clientId}` : ''}`
     }).catch(error => {
       throw new Error('Failed to revoke token', error);
     });

package.json

@@ -18,7 +18,7 @@
   "devDependencies": {
     "babel-eslint": "^8.0.2",
     "babel-jest": "^21.2.0",
-    "babel-preset-es2015": "^6.24.1",
+    "babel-preset-env": "^1.6.1",
     "eslint": "2.10.2",
     "eslint-config-formidable": "^3.0.0",
     "eslint-plugin-filenames": "^1.2.0",
@@ -27,5 +27,6 @@
     "jest": "^21.2.1",
     "react": "^16.1.1",
     "react-native": "^0.50.3"
-  }
+  },
+  "dependencies": {}
 }