feat(local): add refresh token

lib/core/auth.js

@@ -18,7 +18,7 @@ export default class Auth {
     this._redirectListeners = []
 
     // Storage & State
-    options.initialState = { user: null, loggedIn: false }
+    options.initialState = { user: null, loggedIn: false, remember: false, clientId: null }
     const storage = new Storage(ctx, options)
 
     this.$storage = storage
@@ -174,8 +174,9 @@ export default class Auth {
   reset () {
     if (!this.strategy.reset) {
       this.setUser(false)
+      this.setClientId(this.$state.strategy, false)
       this.setToken(this.$state.strategy, false)
-      this.setRefreshToken(this.$state.strategy, false)
+      this.setRemember(this.$state.strategy, undefined)
       return Promise.resolve()
     }
 
@@ -195,36 +196,67 @@ export default class Auth {
     return this.$storage.getUniversal(_key)
   }
 
-  setToken (strategy, token) {
+  setToken (strategy, token, options) {
     const _key = this.options.token.prefix + strategy
 
-    return this.$storage.setUniversal(_key, token)
+    return this.$storage.setUniversal(_key, token, options)
   }
 
-  syncToken (strategy) {
+  syncToken (strategy, options) {
     const _key = this.options.token.prefix + strategy
 
+    return this.$storage.syncUniversal(_key, undefined, options)
+  }
+
+  // ---------------------------------------------------------------
+  // Client ID helpers
+  // ---------------------------------------------------------------
+
+  getClientId (strategy) {
+    const _key = this.options.client_id.prefix + strategy
+
+    return this.$storage.getUniversal(_key)
+  }
+
+  setClientId (strategy, clientId, options) {
+    const _key = this.options.client_id.prefix + strategy
+
+    this.$storage.setState('clientId', clientId)
+
+    return this.$storage.setUniversal(_key, clientId, options)
+  }
+
+  syncClientId (strategy) {
+    const _key = this.options.client_id.prefix + strategy
+
     return this.$storage.syncUniversal(_key)
   }
 
   // ---------------------------------------------------------------
-  // Refresh token helpers
+  // Remember helpers
   // ---------------------------------------------------------------
 
-  getRefreshToken (strategy) {
-    const _key = this.options.refresh_token.prefix + strategy
+  getRemember (strategy) {
+    const _key = this.options.remember.prefix + strategy
 
     return this.$storage.getUniversal(_key)
   }
 
-  setRefreshToken (strategy, refreshToken) {
-    const _key = this.options.refresh_token.prefix + strategy
+  setRemember (strategy, remember) {
+    const _key = this.options.remember.prefix + strategy
+    const options = { expires: null }
+
+    if (remember === true || remember === undefined) {
+      options.expires = this.options.cookie.options.expires
+    }
+
+    this.$storage.setState('remember', remember || false)
 
-    return this.$storage.setUniversal(_key, refreshToken)
+    return this.$storage.setUniversal(_key, remember, options)
   }
 
-  syncRefreshToken (strategy) {
-    const _key = this.options.refresh_token.prefix + strategy
+  syncRemember (strategy) {
+    const _key = this.options.remember.prefix + strategy
 
     return this.$storage.syncUniversal(_key)
   }
@@ -241,6 +273,14 @@ export default class Auth {
     return this.$state.loggedIn
   }
 
+  get remember () {
+    return this.$state.remember
+  }
+
+  get clientId () {
+    return this.$state.clientId
+  }
+
   fetchUserOnce () {
     if (!this.$state.user) {
       return this.fetchUser(...arguments)
@@ -250,6 +290,8 @@ export default class Auth {
 
   setUser (user) {
     this.$storage.setState('loggedIn', Boolean(user))
+    this.$storage.setState('remember', this.getRemember(this.$state.strategy))
+    this.$storage.setState('clientId', this.getClientId(this.$state.strategy))
     this.$storage.setState('user', user)
   }
 
@@ -270,11 +312,7 @@ export default class Auth {
     return this.ctx.app.$axios
       .request(_endpoint)
       .then(response => {
-        if (_endpoint.propertyName) {
-          return getProp(response.data, _endpoint.propertyName)
-        } else {
-          return response.data
-        }
+        return response.data
       })
       .catch(error => {
         // Call all error handlers

lib/core/storage.js

@@ -17,12 +17,12 @@ export default class Storage {
   // Universal
   // ------------------------------------
 
-  setUniversal (key, value, isJson) {
+  setUniversal (key, value, options, isJson) {
     // Local state
     this.setState(key, value)
 
     // Cookies
-    this.setCookie(key, value)
+    this.setCookie(key, value, options)
 
     // Local Storage
     this.setLocalStorage(key, value, isJson)
@@ -47,15 +47,15 @@ export default class Storage {
     return value
   }
 
-  syncUniversal (key, defaultValue, isJson) {
+  syncUniversal (key, defaultValue, options, isJson) {
     let value = this.getUniversal(key, isJson)
 
     if (isUnset(value) && isSet(defaultValue)) {
       value = defaultValue
     }
 
     if (isSet(value)) {
-      this.setUniversal(key, value)
+      this.setUniversal(key, value, options)
     }
 
     return value

lib/core/utilities.js

@@ -1,3 +1,9 @@
+import dotProp from 'dotprop'
+
+export const getProp = (obj, propName) => propName ? dotProp(obj, propName) : obj
+
+export const getRealName = (propName) => propName.split('.').pop()
+
 export const isUnset = o => typeof o === 'undefined' || o === null
 export const isSet = o => !isUnset(o)
 

lib/module/defaults.js

@@ -49,10 +49,16 @@ module.exports = {
     prefix: '_token.'
   },
 
-  // -- Refresh token --
+  // -- Client ID --
 
-  refresh_token: {
-    prefix: '_refresh_token.'
+  client_id: {
+    prefix: '_client_id.'
+  },
+
+  // -- Remember --
+
+  remember: {
+    prefix: '_remember.'
   },
 
   // -- Strategies --
@@ -67,6 +73,11 @@ module.exports = {
           method: 'post',
           propertyName: 'token'
         },
+        refresh: {
+          url: '/api/auth/refresh',
+          method: 'post',
+          propertyName: 'token'
+        },
         logout: {
           url: '/api/auth/logout',
           method: 'post'

lib/module/index.js

@@ -132,6 +132,13 @@ function processStrategies (options) {
       fileName: join('auth', 'schemes', schemeName)
     })
 
+    if (schemeName === 'refresh.js') {
+      this.addTemplate({
+        src: schemeSrc.replace('refresh.js', 'local.js'),
+        fileName: join('auth', 'schemes', schemeName.replace('refresh.js', 'local.js'))
+      })
+    }
+
     // Remove unnecessary fields
     delete strategy._scheme
     delete strategy._provider

lib/schemes/local.js

@@ -1,3 +1,6 @@
+import { getProp } from '../utilities'
+import { getRealName } from '../utilities'
+
 export default class LocalScheme {
   constructor (auth, options) {
     this.$auth = auth
@@ -24,49 +27,67 @@ export default class LocalScheme {
     if (this.options.tokenRequired) {
       const token = this.$auth.syncToken(this.name)
       this._setToken(token)
+      this.$auth.syncClientId(this.name)
+      this.$auth.syncRemember(this.name)
     }
 
     return this.$auth.fetchUserOnce()
   }
 
-  async login (endpoint) {
+  async login (endpoint, remember) {
     if (!this.options.endpoints.login) {
       return
     }
 
     // Ditch any leftover local tokens before attempting to log in
     await this._logoutLocally()
 
-    const result = await this.$auth.request(
-      endpoint,
-      this.options.endpoints.login
-    )
+    // Make login request
+    const loginResult = await this.$auth.request(endpoint, this.options.endpoints.login)
 
-    if (this.options.tokenRequired) {
-      const token = this.options.tokenType
-        ? this.options.tokenType + ' ' + result
-        : result
+    // RememberMe
+    if (remember !== undefined) {
+      this.$auth.setRemember(this.name, remember)
+    }
+    const cookieOptions = { expires: null }
+    if (this.$auth.getRemember(this.name)) {
+      cookieOptions.expires = this.$auth.options.cookie.options.expires
+    }
 
-      this.$auth.setToken(this.name, token)
+    // Update Token
+    if (this.options.tokenRequired) {
+      let token = getProp(loginResult, this.options.endpoints.login.propertyName)
+      if (this.options.tokenType) {
+        token = this.options.tokenType + ' ' + token
+      }
+      this.$auth.setToken(this.name, token, cookieOptions)
       this._setToken(token)
     }
 
+    // Update clientId
+    const clientId = getProp(loginResult, this.options.clientIdProperty)
+    if (clientId) {
+      this.$auth.setClientId(this.name, clientId, cookieOptions)
+    }
+
+    // Fetch user
     return this.fetchUser()
   }
 
-  async setUserToken (tokenValue) {
+  async setUserToken (token) {
     // Ditch any leftover local tokens before attempting to log in
     await this._logoutLocally()
 
+    // Update token
     if (this.options.tokenRequired) {
-      const token = this.options.tokenType
-        ? this.options.tokenType + ' ' + tokenValue
-        : tokenValue
-
+      if (this.options.tokenType) {
+        token = this.options.tokenType + ' ' + token
+      }
       this.$auth.setToken(this.name, token)
       this._setToken(token)
     }
 
+    // Fetch user
     return this.fetchUser()
   }
 
@@ -76,24 +97,31 @@ export default class LocalScheme {
       return
     }
 
-    // User endpoint is disabled.
+    // User endpoint is disabled
     if (!this.options.endpoints.user) {
       this.$auth.setUser({})
       return
     }
 
     // Try to fetch user and then set
-    const user = await this.$auth.requestWith(
-      this.name,
-      endpoint,
-      this.options.endpoints.user
-    )
+    let user = await this.$auth.requestWith(this.name, endpoint, this.options.endpoints.user)
+    user = getProp(user, this.options.endpoints.user.propertyName)
+
     this.$auth.setUser(user)
   }
 
-  async logout (endpoint) {
+  async logout (endpoint = {}) {
     // Only connect to logout endpoint if it's configured
     if (this.options.endpoints.logout) {
+      // Only add client id to payload if enabled
+      const clientId = getRealName(this.options.clientIdProperty)
+      if (clientId) {
+        if (!endpoint.data) {
+          endpoint.data = {}
+        }
+        endpoint.data[clientId] = this.$auth.getClientId(this.name)
+      }
+
       await this.$auth
         .requestWith(this.name, endpoint, this.options.endpoints.logout)
         .catch(() => { })
@@ -116,5 +144,6 @@ const DEFAULTS = {
   tokenRequired: true,
   tokenType: 'Bearer',
   globalToken: true,
-  tokenName: 'Authorization'
+  tokenName: 'Authorization',
+  clientIdProperty: 'client_id'
 }