axios-authorized v2.0.3

axios-authorized

axios wrapper for authorized REST APIs

Why

It is, often, a pain to consume REST APIs that need some kind of authorization. Basically, you need to have a valid access_token to consume one resource. If that access_token is invalid, though, you generally get one 401 error right in your face.

To solve that, you must refresh your access_token using one refresh_token and retry the request. If everything goes wrong, then usually the user is logged out and sent back to the login page.

That is a lot of stuff and it seems to be a common pattern: I have faced that situation in, at least, four projects. So I've decided to make this simple and small package to solve this problem!

Installing

Using npm/yarn:

npm install/yarn add axios-authorized

It uses axios as a peer-dependency, so don't forget to have axios installed!

Usage

The default export contains a function that adapts (returns) one existing axios instance. Example:

import authorizeAxiosInstance from 'axios-authorized'

const network = authorizeAxiosInstance({
  instance,
  tokenProvider,
  refreshTokenRequest,
})

network.get('/me')
  .then((response) => console.log(response.data))
  .catch((e) => console.error('well, it did not work out so well...', e))

The only argument for authorizeAxiosInstance is an options object with the properties:

instance (required)

A regular axios instance. axios.create(...config), for example

tokenProvider (required)

Is an object with getters and setters for both the access and refresh tokens:

let accessToken = ''
let refreshToken = ''

const tokenProvider = {
  accessToken: {
    get: () => Promise.resolve(accessToken),
    set: (newAccessToken) => Promise.resolve(accessToken = newAccessToken),
  },

  refreshToken: {
    get: () => Promise.resolve(refreshToken),
    set: (newRefreshToken) => Promise.resolve(refreshToken = newRefreshToken),
  },
}

The nice thing about it is that you can use AsyncStorage, for example, as it demands a Promise to be resolved.

Even if you use a sync method (like getting a cookie from the browser), you still need to resolve a Promise!!!

refreshTokenRequest (required)

A function that returns a Promise with both new tokens as an object (in the resolve function call). The axios instance and both old tokens are passed as arguments. Example:

function refreshTokenRequest({ instance, oldTokens }) {
  return new Promise(async (resolve, reject) => {
    try {
      const { data } = await instance.get('/token', {
        header: {
          Authorization: `Bearer ${oldTokens.refreshToken}`,
        }
      })
      
      resolve({
        accessToken: data.accessToken,
        refreshToken: data.refreshToken,
      })
    } catch(e) {
      reject(e)
    }
  })
}

setHeaders (optional)

A function to set the request headers. Example:

function setHeaders({ requestConfig, tokens }) {
  requestConfig.headers.Authorization = `Bearer ${tokens.accessToken}`

  return requestConfig
}

By default, it sets the Authorization header as a Bearer with the accessToken

isInvalid (optional)

A callback to check if the desired request is invalid. Example:

function isInvalid(response: AxiosResponse) {
  return response.status === 401
}

By default, it checks for a 401 status in the response headers

errorCallback (optional)

Callback invoked when things go south (after a refresh token failure, for example). By default, it does nothing (noop)

Note: the error is still thrown, just like a failed request would! That is just an external callback

License

MIT