vinayakkulkarni/auth

OAuth Module for Nuxt 3

🔒 @bitinflow/nuxt-oauth

@bitinflow/nuxt-oauth is a Nuxt 3 Module that provides a simple OAuth 2 implementation for static site nuxt applications for which no backend code is required. It uses the recommended Authorization Code Grant with PKCE by default and supports Implicit Grant Tokens as well.

This package is intended to be used with Laravel Passport, allowing users to interact with their first-party API using their own OAuth provider. Currently, it does not support multiple OAuth providers. With @bitinflow/nuxt-oauth, developers can quickly and easily implement secure OAuth authentication in their Nuxt applications.

• ✨  Release Notes

Features

• 📦 Authorization Code Grant with PKCE (default)
• 📦 Simple OAuth 2 Implicit Grant Token authentication (not recommended)
• 📦 Intended to be used with laravel-passport
• 📦 Single OAuth provider support (currently)

Quick Setup

Note: Starting with @bitinflow/nuxt-oauth v2.0.0, the default response type is code. If you want to use the token response type, you need to set it explicitly in the configuration.

1. Add @bitinflow/nuxt-oauth dependency to your project

# Using pnpm
pnpm add -D @bitinflow/nuxt-oauth

# Using yarn
yarn add --dev @bitinflow/nuxt-oauth

# Using npm
npm install --save-dev @bitinflow/nuxt-oauth

2. Add @bitinflow/nuxt-oauth to the modules section of nuxt.config.ts and disable ssr.

Or alternatively disable ssr via routeRules, only for pages where auth or guest middlewares are needed. Typically account section and login page.

export default defineNuxtConfig({
  modules: [
    '@bitinflow/nuxt-oauth'
  ],

  ssr: false,
  // or
  routeRules: {
    '/dashboard/**': {ssr: false},
    '/whatever/**': {ssr: false}
  },

  // using code response type (default)
  oauth: {
    endpoints: {
      authorization: 'https://example.com/oauth/authorize',
      token: 'https://example.com/oauth/token',
      userInfo: 'https://example.com/api/users/me',
      logout: 'https://example.com/oauth/logout'
    },
    clientId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    scope: ['user:read']
  },

  // using token response type (not recommended)
  oauth: {
    endpoints: {
      authorization: 'https://example.com/oauth/authorize',
      userInfo: 'https://example.com/api/users/me',
      logout: 'https://example.com/oauth/logout'
    },
    clientId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    responseType: 'token',
    scope: ['user:read']
  },
})

This will be your callback url (host is determined by window.location.origin):

• Callback: http://localhost:3000/login

That's it! You can now use @bitinflow/nuxt-oauth in your Nuxt app ✨

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