feat(baseConfig): change refreshTokenName option value and add `ref…

…reshTokenProp` (breaking) BREAKING CHANGE: `refreshTokenName` option value has been changed from 'refresh_token' to 'token'. The new `refreshTokenProp` option is set to 'refresh_token' by default (a non-breaking change).
SpoonX · Apr 9, 2016 · c8885d7 · c8885d7
1 parent 4f98493
commit c8885d7
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -348,13 +348,15 @@ autoUpdateToken: true,
 clientId: false,
 // The property name used when storing the refresh token locally
 refreshTokenStorage: 'aurelia_refresh_token',
+// The the property from which to get the refresh token after a successful token refresh
+refreshTokenProp: 'refresh_token',
 
-// If `refresh_token` is an object:
-// ------------------------------------------------------------
+// If the property defined by `refreshTokenProp` is an object:
+// -----------------------------------------------------------
 
-// This is the property from which to get the token `{ "refresh_token": { "refreshTokenName" : '...' } }`
-refreshTokenName: 'refresh_token',
-// This allows the refresh token to be a further object deeper `{ "refresh_token": { "refreshTokenRoot" : { "refreshTokenName" : '...' } } }`
+// This is the property from which to get the token `{ "refreshTokenProp": { "refreshTokenName" : '...' } }`
+refreshTokenName: 'token',
+// This allows the refresh token to be a further object deeper `{ "refreshTokenProp": { "refreshTokenRoot" : { "refreshTokenName" : '...' } } }`
 refreshTokenRoot: false,
 
 

diff --git a/src/authentication.js b/src/authentication.js
@@ -88,7 +88,7 @@ export class Authentication {
   }
 
   setRefreshTokenFromResponse(response) {
-    let refreshToken = response && response.refresh_token;
+    let refreshToken = response && response[this.config.refreshTokenProp];
     let token;
 
     if (refreshToken) {

diff --git a/src/baseConfig.js b/src/baseConfig.js
@@ -88,13 +88,15 @@ export class BaseConfig {
       clientId: false,
       // The property name used when storing the refresh token locally
       refreshTokenStorage: 'aurelia_refresh_token',
+      // The the property from which to get the refresh token after a successful token refresh
+      refreshTokenProp: 'refresh_token',
 
-      // If `refresh_token` is an object:
-      // ------------------------------------------------------------
+      // If the property defined by `refreshTokenProp` is an object:
+      // -----------------------------------------------------------
 
-      // This is the property from which to get the token `{ "refresh_token": { "refreshTokenName" : '...' } }`
-      refreshTokenName: 'refresh_token',
-      // This allows the refresh token to be a further object deeper `{ "refresh_token": { "refreshTokenRoot" : { "refreshTokenName" : '...' } } }`
+      // This is the property from which to get the token `{ "refreshTokenProp": { "refreshTokenName" : '...' } }`
+      refreshTokenName: 'token',
+      // This allows the refresh token to be a further object deeper `{ "refreshTokenProp": { "refreshTokenRoot" : { "refreshTokenName" : '...' } } }`
       refreshTokenRoot: false,