RFC: Documentation Ideas

Describe the feature

Add documentation and optionally sample code for:

• example to configure different dbs
• laravel sanctum
  • requests: #16 + more on discord
• laravel JWT
  • requests: #32 + more on discord
• optional user data (partially from #29)
  • added as recipe in #90: https://sidebase.io/nuxt-auth/recipes/custom-session-data
• directus (see #64)
  • added as recipe in #90: https://sidebase.io/nuxt-auth/recipes/directus
• strapi example (from https://discord.com/channels/473401852243869706/1038034318703984650/1041080023219716256)
  • added as recipe in #90: https://sidebase.io/nuxt-auth/recipes/strapi
• how to add your own signin page
  • added in #90: https://sidebase.io/nuxt-auth/application-side/custom-sign-in-page
• security section (from #7)
  • added in #90: https://sidebase.io/nuxt-auth/further-reading/security
• how to pass credentials to the credential signIn directly (see [2])
  • added in #90: https://sidebase.io/nuxt-auth/application-side/session-access-and-management

Additional information

[1] attempt at strapi from discord user Hum+ (thanks 🙇 )

import CredentialsProvider from "next-auth/providers/credentials";
import { NuxtAuthHandler } from "#auth";

export default NuxtAuthHandler({
  secret: process.env.NUXT_SECRET,
  providers: [
    // @ts-ignore Import is exported on .default during SSR, so we need to call it this way. May be fixed via Vite at some point
    CredentialsProvider.default({
      // The name to display on the sign in form (e.g. 'Sign in with...')
      name: "Credentials",

      // Strapi expects { identifier: 'username or email', password: 'abcde' } we can deal with this at the fetch req
      credentials: {
        username: { label: 'Username', type: 'text', placeholder: 'Test user' },
        password: { label: 'Password', type: 'password' }
      },
      async authorize(credentials: any) {

        const user = await $fetch(`${process.env.STRAPI_BASE_URL}/api/auth/local/`, {
          method: "POST",
          body: JSON.stringify({
            identifier: credentials.username,
            password: credentials.password,
          }),
        });

        if (user) {
         
          return user;
        } else {
         
          return null;

        }
      },
    }),
  ],
  session: {
    jwt: true,
  },

});

[2] passing username and password to signIn, e.g., to use on ytour own page:

await signIn('credentials', { callbackUrl: '/', username: 'jsmith', password: 'hunter2' })

[danpastori]

@BracketJohn Would be really stoked for Sanctum support as well! Check out this repo if you need any inspiration. It works great for Sanctum Auth: https://github.com/amrnn90/breeze-nuxt.

[madsh93]

Hi @BracketJohn

Would it be possible to add Directus CMS documentation as well? I am having troubles with refresh tokens. I’ve made a gist on my current setup.

https://gist.github.com/madsh93/eb2e36d19af3e73bfec8251f51448bc5

I’ll happily provide access to a Directus CMS to test. I’m on Sidebase Discord server if you’d like to discuss it “Mads#6530”.