npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

axios-refresh-jwt

v1.2.0

Published

Axios Request Interceptor to Refresh The JWT access token.

Downloads

28

Readme

Axios JWT Refresh

Simple npm package that lets you refresh your access token with axios Interceptor. Simple and Elegant.

Npm:

npm i axios-refresh-jwt

Yarn:

yarn add axios-refresh-jwt

Usage:

Define Storage Object:

Basically, this storage object is used by axios-jwt-refresh to store, retrieve, and update the tokens for API calls. If you're using TypeScript, consider creating a Storage object from IStorage type at axios-jwt-refresh/types

Storage Object

import {IStorage} from 'axios-jwt-refresh/types'

const Storage: IStorage  = {
    setTokens: (tokens) => {
        localStorage.setItem("ACCESS_TOKEN", tokens.accessToken)
        localStorage.setItem("REFRESH_TOKEN", tokens.refreshToken)
    },

    updateAccessToken: ({accessToken}) => {
        localStorage.setItem("ACCESS_TOKEN", accessToken)
    },

    removeTokens: () => {
        localStorage.removeItem("ACCESS_TOKEN")
        localStorage.removeItem("REFRESH_TOKEN")
    },

    getTokens: () => {
        return {
            accessToken: localStorage.getItem("ACCESS_TOKEN"),
            refreshToken: localStorage.getItem("REFRESH_TOKEN")
        }
    }
}

API Client

requestInterceptor accepts the following params:

  • axiosInstance: actual axios instance.
  • tokenStorage: token storage class. The method signature is as above. It must be of type: IStorage
  • onTokenSuccess: called when the new token request succeeds. axiosConfig, accessToken are callback params.
  • onTokenFailure: called when the new token request fails. tokenStorage, axiosConfig are callback params.
  • getNewToken: async function that handles getting a new token with refreshToken. Note that this mustn't be the call from axiosInstance to prevent the request looping.
  • expiryKey: expiry key in token payload. You can check the decoded token right here. If unset, the default value is exp.
  • authHeaderName: auth header to use for subsequent requests. If unset, the default value isAuthorization.
  • tokenPrefix: token prefix string. If unset, the default value is Bearer.
import axios from 'axios';

import requestInterceptor from 'axios-jwt-refresh'

const API_URL = "http://foo.bar/api"

const api = axios.create({
    baseURL: API_URL
})

requestInterceptor({
    axiosInstance: api, // axios instance
    tokenStorage: Storage, // your preferred storage, IStorage type
    expiryKey: "exp", // default, optional
    authHeaderName: "Authorization", // default, optional
    tokenPrefix: "Bearer", // default, optional
    getNewToken: async ({refreshToken}) => { // must be instantiated from axios to prevent infinite loop
        const resp = await axios.post(`${API_URL}/token/refresh/`, {
            "refresh": refreshToken
        })
        const token = resp.data.access
        return token
    },
    onTokenFailure: ({tokenStorage, axiosConfig}) => { // called when refreshing token fails
        tokenStorage.removeTokens()
        window.location.reload()
    },
    onTokenSuccess: ({axiosConfig, accessToken}) => { // called when obtaining a token succeeds
        console.log("Token successfully updated")
    
        if(axiosConfig.url == "/token/verify/" && accessToken){
            axiosConfig.data = {
                "token": accessToken
            }
        }
    }
})

export default api;