feat(baseConfig): standardize access token option names (breaking)

BREAKING CHANGE: This aligns access token option names with the refresh token option names. The option changes are as follows: ``` tokenStorage => accessTokenStorage responseTokenProp => accessTokenProp tokenName => accessTokenName tokenRoot => accessTokenRoot ```
SpoonX · Apr 9, 2016 · 29d22c5 · 29d22c5
1 parent c8885d7
commit 29d22c5
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -323,18 +323,18 @@ unlinkMethod: 'get',
 authHeader: 'Authorization',
 // The token name used in the header of API requests that require authentication
 authToken: 'Bearer',
-// The property name used when storing the token locally
-tokenStorage: 'aurelia_access_token',
-// The the property from which to get the authentication token after a successful login or signup
-responseTokenProp: 'access_token',
+// The property name used when storing the access token locally
+accessTokenStorage: 'aurelia_access_token',
+// The the property from which to get the access token after a successful login or signup
+accessTokenProp: 'access_token',
 
-// If the property defined by `responseTokenProp` is an object:
+// If the property defined by `accessTokenProp` is an object:
 // ------------------------------------------------------------
 
-//This is the property from which to get the token `{ "responseTokenProp": { "tokenName" : '...' } }`
-tokenName: 'token',
-// This allows the token to be a further object deeper `{ "responseTokenProp": { "tokenRoot" : { "tokenName" : '...' } } }`
-tokenRoot: false,
+//This is the property from which to get the token `{ "accessTokenProp": { "accessTokenName" : '...' } }`
+accessTokenName: 'token',
+// This allows the token to be a further object deeper `{ "accessTokenProp": { "accessTokenRoot" : { "accessTokenName" : '...' } } }`
+accessTokenRoot: false,
 
 
 // Refresh Token Options

diff --git a/src/authentication.js b/src/authentication.js
@@ -31,15 +31,15 @@ export class Authentication {
   }
 
   getToken() {
-    return this.storage.get(this.config.tokenStorage);
+    return this.storage.get(this.config.accessTokenStorage);
   }
 
   getRefreshToken() {
     return this.storage.get(this.config.refreshTokenStorage);
   }
 
   getPayload() {
-    let token = this.storage.get(this.config.tokenStorage);
+    let token = this.storage.get(this.config.accessTokenStorage);
 
     if (token && token.split('.').length === 3) {
       let base64Url = token.split('.')[1];
@@ -53,7 +53,7 @@ export class Authentication {
   }
 
   setTokenFromResponse(response, redirect) {
-    let accessToken = response && response[this.config.responseTokenProp];
+    let accessToken = response && response[this.config.accessTokenProp];
     let token;
 
     if (accessToken) {
@@ -65,20 +65,20 @@ export class Authentication {
     }
 
     if (!token && response) {
-      token = this.config.tokenRoot && response[this.config.tokenRoot]
-        ? response[this.config.tokenRoot][this.config.tokenName]
-        : response[this.config.tokenName];
+      token = this.config.accessTokenRoot && response[this.config.accessTokenRoot]
+        ? response[this.config.accessTokenRoot][this.config.accessTokenName]
+        : response[this.config.accessTokenName];
     }
 
     if (!token) {
-      let tokenPath = this.config.tokenRoot
-        ? this.config.tokenRoot + '.' + this.config.tokenName
-        : this.config.tokenName;
+      let accessTokenPath = this.config.accessTokenRoot
+        ? this.config.accessTokenRoot + '.' + this.config.accessTokenName
+        : this.config.accessTokenName;
 
-      throw new Error('Expecting a token named "' + tokenPath + '" but instead got: ' + JSON.stringify(response));
+      throw new Error('Expecting a token named "' + accessTokenPath + '" but instead got: ' + JSON.stringify(response));
     }
 
-    this.storage.set(this.config.tokenStorage, token);
+    this.storage.set(this.config.accessTokenStorage, token);
 
     if (this.config.loginRedirect && !redirect) {
       window.location.href = this.config.loginRedirect;
@@ -117,15 +117,15 @@ export class Authentication {
   }
 
   removeToken() {
-    this.storage.remove(this.config.tokenStorage);
+    this.storage.remove(this.config.accessTokenStorage);
   }
 
   removeRefreshToken() {
     this.storage.remove(this.config.refreshTokenStorage);
   }
 
   isAuthenticated() {
-    let token = this.storage.get(this.config.tokenStorage);
+    let token = this.storage.get(this.config.accessTokenStorage);
 
     // There's no token, so user is not authenticated.
     if (!token) {
@@ -167,7 +167,7 @@ export class Authentication {
 
   logout(redirect) {
     return new Promise(resolve => {
-      this.storage.remove(this.config.tokenStorage);
+      this.storage.remove(this.config.accessTokenStorage);
       this.storage.remove(this.config.refreshTokenStorage);
 
       if (this.config.logoutRedirect && !redirect) {

diff --git a/src/baseConfig.js b/src/baseConfig.js
@@ -63,18 +63,18 @@ export class BaseConfig {
       authHeader: 'Authorization',
       // The token name used in the header of API requests that require authentication
       authToken: 'Bearer',
-      // The property name used when storing the token locally
-      tokenStorage: 'aurelia_access_token',
-      // The the property from which to get the authentication token after a successful login or signup
-      responseTokenProp: 'access_token',
+      // The property name used when storing the access token locally
+      accessTokenStorage: 'aurelia_access_token',
+      // The the property from which to get the access token after a successful login or signup
+      accessTokenProp: 'access_token',
 
-      // If the property defined by `responseTokenProp` is an object:
+      // If the property defined by `accessTokenProp` is an object:
       // ------------------------------------------------------------
 
-      //This is the property from which to get the token `{ "responseTokenProp": { "tokenName" : '...' } }`
-      tokenName: 'token',
-      // This allows the token to be a further object deeper `{ "responseTokenProp": { "tokenRoot" : { "tokenName" : '...' } } }`
-      tokenRoot: false,
+      //This is the property from which to get the token `{ "accessTokenProp": { "accessTokenName" : '...' } }`
+      accessTokenName: 'token',
+      // This allows the token to be a further object deeper `{ "accessTokenProp": { "accessTokenRoot" : { "accessTokenName" : '...' } } }`
+      accessTokenRoot: false,
 
 
       // Refresh Token Options