chore: init

Author: atinux

.eslintrc

@@ -16,6 +16,10 @@ Minimalist Authentication module for Nuxt.
 - Secured & sealed cookies sessions
 - OAuth Providers
 
+## Requirements
+
+This module only works with SSR (server-side rendering) enabled as it uses server API routes. You cannot use this module with `nuxt generate`.
+
 ## Quick Setup
 
 1. Add `nuxt-auth-core` dependency to your project
@@ -141,7 +145,11 @@ Example: `~/server/routes/auth/github.get.ts`
 ```ts
 export default oauth.githubEventHandler({
   async onSuccess(event, { user, tokens }) {
-    await setUserSession(event, { user })
+    await setUserSession(event, {
+      user: {
+        githubId: user.id
+      }
+    })
     return sendRedirect(event, '/')
   },
   // Optional, will return a json error and 401 status code by default

README.md

@@ -28,15 +28,20 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.8.0"
+    "@nuxt/kit": "^3.8.0",
+    "defu": "^6.1.3",
+    "ohash": "^1.1.3"
   },
   "devDependencies": {
-    "@types/node": "^20.8.9",
+    "@iconify-json/simple-icons": "^1.1.76",
     "@nuxt/devtools": "latest",
     "@nuxt/eslint-config": "^0.2.0",
     "@nuxt/module-builder": "^0.5.2",
     "@nuxt/schema": "^3.8.0",
     "@nuxt/test-utils": "^3.8.0",
+    "@nuxt/ui": "^2.10.0",
+    "@nuxt/ui-pro": "^0.4.2",
+    "@types/node": "^20.8.9",
     "changelogen": "^0.5.5",
     "eslint": "^8.52.0",
     "nuxt": "^3.8.0",

package.json

@@ -1,3 +1,7 @@
 NUXT_SESSION_PASSWORD=
+# GitHub OAuth
 NUXT_OAUTH_GITHUB_CLIENT_ID=
 NUXT_OAUTH_GITHUB_CLIENT_SECRET=
+# Spotify OAuth
+NUXT_OAUTH_SPOTIFY_CLIENT_ID=
+NUXT_OAUTH_SPOTIFY_CLIENT_SECRET=

playground/.env.example

@@ -0,0 +1,16 @@
+module.exports = {
+  root: true,
+  extends: [
+    '@nuxt/eslint-config'
+  ],
+  rules: {
+    // Global
+    semi: ['error', 'never'],
+    quotes: ['error', 'single'],
+    'quote-props': ['error', 'as-needed'],
+    // Vue
+    'vue/multi-word-component-names': 0,
+    'vue/max-attributes-per-line': 'off',
+    'vue/no-v-html': 0
+  }
+}

playground/.eslintrc.cjs

@@ -1,10 +1,43 @@
 <script setup>
-const { loggedIn } = useUserSession()
+const { loggedIn, session, clear } = useUserSession()
 </script>
 
 <template>
-  <div>
-    Nuxt module playground!
-    {{ loggedIn ? 'Logged in' : 'Not logged in' }}
-  </div>
+  <UHeader>
+    <template #right>
+      <UButton
+        v-if="!loggedIn || !session.user.github"
+        to="/auth/github"
+        icon="i-simple-icons-github"
+        external
+        color="gray"
+        size="xs"
+      >
+        Login with GitHub
+      </UButton>
+      <UButton
+        v-if="!loggedIn || !session.user.spotify"
+        to="/auth/spotify"
+        icon="i-simple-icons-spotify"
+        external
+        color="gray"
+        size="xs"
+      >
+        Login with Spotify
+      </UButton>
+      <UButton
+        v-if="loggedIn"
+        color="gray"
+        size="xs"
+        @click="clear"
+      >
+        Logout
+      </UButton>
+    </template>
+  </UHeader>
+  <UMain>
+    <UContainer>
+      <NuxtPage />
+    </UContainer>
+  </UMain>
 </template>

playground/app.vue

@@ -1,6 +1,13 @@
 export default defineNuxtConfig({
-  modules: ['../src/module'],
+  extends: ['@nuxt/ui-pro'],
+  modules: [
+    '../src/module',
+    '@nuxt/ui'
+  ],
   auth: {},
+  ui: {
+    icons: ['simple-icons']
+  },
   devtools: { enabled: true },
   imports: {
     autoImport: true

playground/nuxt.config.ts

@@ -0,0 +1,7 @@
+<script setup>
+const { session } = useUserSession()
+</script>
+
+<template>
+  <pre>{{ session }}</pre>
+</template>

playground/pages/index.vue

@@ -1,7 +1,11 @@
 export default oauth.githubEventHandler({
-  onSuccess(event, res) {
-    console.log(res)
+  async onSuccess(event, { user }) {
+    await setUserSession(event, {
+      user: {
+        github: user,
+      }
+    })
 
-    return { success: true }
+    return sendRedirect(event, '/')
   }
 })

playground/server/routes/auth/github.get.ts

@@ -0,0 +1,11 @@
+export default oauth.spotifyEventHandler({
+  async onSuccess(event, { user }) {
+    await setUserSession(event, {
+      user: {
+        spotify: user,
+      }
+    })
+
+    return sendRedirect(event, '/')
+  }
+})