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

nuxt-jwt-auth

v1.0.0

Published

A Nuxt module to authenticate on a custom backend (Laravel Sanctum) via jwt token

Downloads

259

Readme

Nuxt JWT Auth

npm version npm downloads License Nuxt

A Nuxt module to authenticate on a custom backend (Laravel) via jwt token.

Features

  • 🔌 Manage login, logout, protected api requests with $jwtAuth plugin
  • 🪝 Access to user data with useJwtAuth composable
  • 🖥️ Works also in SSR mode
  • ❤️ Heavily inspired by the awesome nuxt-sanctum-auth

Quick Setup

  1. Add nuxt-jwt-auth dependency to your project
# Using pnpm
pnpm add -D nuxt-jwt-auth

# Using yarn
yarn add --dev nuxt-jwt-auth

# Using npm
npm install --save-dev nuxt-jwt-auth
  1. Add nuxt-jwt-auth to the modules section of nuxt.config.ts
// nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-jwt-auth'
  ]
})
  1. Add configuration object nuxt-jwt-auth
// nuxt.config.ts

export default defineNuxtConfig({
  // ...
  nuxtJwtAuth: {
    baseUrl: 'http://homestead.test/api', // URL of your backend
    endpoints: {
      login: '/login', // Where to request login (POST)
      logout: '/logout', // Where to request logout (POST)
      user: '/user', // Where to request user data (GET)
      signup: '/signup' // Where to request signup (POST)
    },
    redirects: {
      home: '/', // Where to redirect after successfull login and logout
      login: '/login', // Where to redirect if user is not logged in and accesses a logged-only route
      logout: '/logout' // Where to redirect if user is logged in and accesses a guest-only route 
    }
  }
})

How to use

Login

This modules provides the $jwtAuth plugin, which contains login and logout methods.

Login function accepts credentials, which are passed as-is to the backend, as first argument. You can optionally provide a callback function as second argument. This function will receive the response from the backend.

If no callback function is provided, the user will be redirected to the home route specified in configuration after successful login.

<script setup>
const { $jwtAuth } = useNuxtApp()
const router = useRouter()

async function login() {
  try {
    await $jwtAuth.login(
      {
        email: '[email protected]',
        password: 'supersecretpassword'
      },
      // optional callback function
      (data) => {
        console.log(data)
        window.location.replace('/')
      }
    )
  } catch (e) {
    // your error handling
  }
}
</script>

⚠️ If using custom callback function, you must always navigate to another route using window.location.replace(). Some auth data may not be updated if navigating "in-app" with router.push() or nuxt's navigateTo()

⚠️ It is requested that the backend responds to the login request with a JSON object containing both token and user properties:

{
  "token": "1|TjVJavoOkerwXViiRwLBLsd1xGSRoYosiO87zSEr",
  "user": {
    "name": "Mario",
    "surname": "Rossi",
    "address": "Fake St. 123"
  }
}

Signup

This modules provides the $jwtAuth plugin, which contains signup method.

Signup function accepts registration data, which are passed as-is to the backend, as first argument. You can optionally provide a callback function as second argument. This function will receive the response from the backend.

If no callback function is provided, the user will be redirected to the home route specified in configuration after successful signup.

<script setup>
const { $jwtAuth } = useNuxtApp()
const router = useRouter()

async function signup() {
  try {
    await $jwtAuth.signup(
      {
        username: 'Mario Rossi',
        email: '[email protected]',
        password: 'supersecretpassword',
        password_confirm: 'supersecretpassword'
      },
      // optional callback function
      (data) => {
        console.log(data)
        router.push('/account')
      }
    )
  } catch (e) {
    // your error handling
  }
}
</script>

Please note that it is requested that the backend responds to the signup request with a JSON object containing both token and user properties:

{
  "token": "1|TjVJavoOkerwXViiRwLBLsd1xGSRoYosiO87zSEr",
  "user": {
    "name": "Mario",
    "surname": "Rossi",
    "address": "Fake St. 123"
  }
}

Route middlewares

This modules provides two route middleware you can optionally add to pages.

auth

Use this middleware in pages where user must be logged in (such as /account)

<script setup>
definePageMeta({
  middleware: 'auth'
})
</script>

guest

Use this middleware in pages where user must not be logged in (such as /login)

<script setup>
definePageMeta({
  middleware: 'guest'
})
</script>

Get the user (useJwtAuth)

This modules provides the useJwtAuth composable, which you can use to obtain useful auth-related data, such as user, token, loggedIn state.

⚠️ All variables obtained from useJwtAuth are computed properties, to reflect changes in cookie data.

<template>
  <h1>Hello,</h1>
  <h2 v-if="loggedIn">{{user.name}}</h2>
</template>

<script setup>
const { user, loggedIn } = useJwtAuth()

</script>

ℹ️ If using typescript, you can specify the user type!

<script setup lang="ts">

interface User {
  name: string
}  
  
const { user, loggedIn } = useJwtAuth<User>()
  
console.log('user name is', user.name) // user.name is of type string now 

</script>

Protected data fetch (fetch)

By using the fetch function of $jwtAuth plugin, you can send standard api requests to the backend.

<script setup>
const { $jwtAuth } = useNuxtApp()

async function fetchMyData() {
  try {
    const myData = await $jwtAuth.fetch('my-api-route')
    // do something with received data...
  } catch (e) {
    // your error handling
  }
}
</script>

Logout

This modules provides the $jwtAuth plugin, which contains login and logout methods.

<script setup>
const { $jwtAuth } = useNuxtApp()

async function logout() {
  try {
    await $jwtAuth.logout()
  } catch (e) {
    // your error handling
  }
}
</script>

Setting cookie data externally

In special cases, you can manage authentication externally and set token and user data by using setUser, setToken or setTokenAndUser functions.

<script setup>
const { $jwtAuth } = useNuxtApp()

async function externalLogin() {
  try {
    // special login executed externally

    const token = "1|TjVJavoOkerwXViiRwLBLsd1xGSRoYosiO87zSEr"
    const user = {
      "name": "Mario",
      "surname": "Rossi",
      "address": "Fake St. 123"
    }
    
    $jwtAuth.setToken(token)
    $jwtAuth.setUser(user)

    // same as
    $jwtAuth.setTokenAndUser({
      token,
      user
    })
    
  } catch (e) {
    // your error handling
  }
}
</script>

Known issues

Layouts

User data displayed in the nuxt layout (ex. username on the right of an app bar) is not updated until a full server page reload. So, if you provide a callback to the login method and in this callback you push to another route (on the client), user data will not be displayed in the layout.

This is a bug/feature of nuxt itself, which does not refresh layouts data when navigating on the client.

To solve this, add key argument to nuxt-layout:

<nuxt-layout :key="$route.path">
  <nuxt-page />
</nuxt-layout>

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release