auth

Auth

Módulo de autenticação alternativo para nuxt

Informações

Este módulo é uma alternativa a @nuxtjs/auth, exceto que isso é para o Nuxt3 apenas sem suporte de compatibilidade com versões anteriores.

Configurar

1. Adicionar @nuxt-alt/auth e @nuxt-alt/http dependência ao seu projeto

yarn add @nuxt-alt/auth @nuxt-alt/http

2. Adicionar @nuxt-alt/auth e @pinia/nuxt à seção de modules de nuxt.config.ts

Nota: Você não precisa especificar @nuxt-alt/http , ele será adicionado automaticamente, mas se você deseja adicioná-lo manualmente, verifique se está abaixo do módulo de autenticação (e acima do módulo proxy se estiver usando). Ele também não precisa de Pinia, usará o uso useState do Nuxt por padrão.

 export default defineNuxtConfig ( {
    modules : [
        '@nuxt-alt/auth'
    ] ,
    auth : {
        /* module options */
    }
} ) ; 

Documentação

Leia a documentação

Mudanças

O módulo agora usa '@nuxt-alt/http' para funcionar, esse módulo estende ohmyfetch. Observe que, se você estava usando data para publicar dados, agora precisará usar body pois é isso que ohmyfetch usa. Se você pretende usar o SSR, considere usar o módulo @nuxt-alt/proxy .

Composível

Um useAuth() composto está disponível para acessar os métodos de autenticação.

Opções

A maioria das opções é tirada diretamente do módulo @nuxtjs/auth. Além disso, existem algumas opções extras disponíveis.

globalMiddleware

• Tipo: Boolean
• Padrão: false

Ativa/desativa o middleware a ser usado globalmente.

enableMiddleware

• Tipo: Boolean
• Padrão: true

Ativa/desativa o middleware embutido.

stores.state.namespace

• Tipo: String
• Padrão: auth

Este é o espaço para o nome de usar para o Nuxt Usestate.

stores.pinia.enabled

• Tipo: Boolean
• Padrão: false

Habilite esta opção para usar a loja Pinia, BEY PADRÃO Este é desativado e useState da Nuxt é usado.

stores.pinia.namespace

• Tipo: String
• Padrão: auth

Este é o espaço para o nome de usar para a loja Pinia.

stores.local.enabled

• Tipo: Boolean
• Padrão: true

Habilite esta opção para usar a loja LocalStorage.

stores.local.prefix

• Tipo: String
• Padrão: auth.

Isso define o prefixo LocalStorage.

stores.session.enabled

• Tipo: Boolean
• Padrão: true

Habilite esta opção para usar a loja SessionStorage.

stores.session.prefix

• Tipo: String
• Padrão: auth.

Semelhante à opção LocalStorage, este é o prefixo para armazenamento de sessão.

stores.cookie.enabled

• Tipo: Boolean
• Padrão: true

Habilite esta opção para usar o armazenamento de cookies.

stores.cookie.prefix

• Tipo: String
• Padrão: auth.

Semelhante à opção LocalStorage, este é o prefixo para o armazenamento de biscoitos.

stores.cookie.options

• Tipo: Object
• Padrão: { path: '/' }

As opções de armazenamento de cookies padrão.

redirectStrategy

• Tipo: query | storage
• Padrão: storage

O tipo de estratégia de redirecionamento que você deseja usar, storage utiliza localização para redirecionamentos, query utilizando os parâmetros de consulta de rota.

tokenValidationInterval

• Tipo: Boolean | Number
• Padrão: false

Isso é experimental. Se definido como true, o intervalo padrão é de 1000ms, caso contrário, defina o tempo em milissegundos. É com que frequência o módulo com tentativa de validar o token para expiração.

resetOnResponseError

• Tipo: Boolean | Function
• Padrão: false

Quando ativado, ele será redefinido quando houver um erro 401 em qualquer uma das respostas. Você é capaz de transformar isso em uma função para lidar com isso você mesmo:

auth: {
    //... module options
    resetOnResponseError : ( error , auth , scheme ) => {
       if ( error . response . status === 401 ) {
           scheme . reset ?. ( )
           auth . redirect ( 'login' )
       }
   } ,
} 

TypeScript (2.6.0+)

As informações do usuário podem ser editadas como para o TypeScript:

 declare module '@nuxt-alt/auth' {
    interface UserInfo {
        email : string
        name : string
    }
} 

Tokens (tipos)

Além dos tokens de autenticação;

Por padrão, o $auth.strategy getter usa o tipo de Scheme que não possui tipos de propriedade token ou refreshToken . Para ajudar com isso, uma $auth.refreshStrategy e um $auth.tokenStrategy getter foram adicionados para digitar. Todos eles fazem a mesma coisa, isso é apenas para o tipo sugestão.

OAuth2

OAuth2 agora tem autenticação da janela do cliente graças a esta solicitação de puxar: Nuxt-Community/Auth-Module#1746

As propriedades foram alteradas para:

clientWindow

• Tipo: Boolean
• Padrão: false

Ativar/desativar o uso de um pop -up para autenticação do cliente.

clientWidth

• Tipo: Number
• Padrão: 400

A largura da janela do cliente.

clientHieght

• Tipo: Number
• Padrão: 600

A largura da janela do cliente.

Aliases

Aliases disponíveis para usar no Nuxt

• #auth/runtime
• #auth/utils
• #auth/providers