1.0.4 • Published 3 years ago
@naveteam/pandora-frontend v1.0.4
❗️ Motivação
Pacote com facilitadores para o seu fluxo de autenticação no front-end.
🚀 Instalação
No Terminal, execute
yarn add @naveteam/pandora-frontend axios
// ou npm install @naveteam/pandora-frontend axios💡 Utilização
OAuth2: Para utilizar o módulo oauth2, inicialize uma instancia da sua api da seguinte forma
import { OAuth2 } from '@naveteam/pandora-frontend'
const options = { api_url: process.env.API_URL }
const instance = OAuth2.createInstance(options)O objeto de opções, pode receber os seguintes parâmetros:
| Parâmetro | Valor padrão | Descrição |
|---|---|---|
| api_url | - | URL base da api que será utilizada |
| access_token_name | @access_token | Nome da key no local storage que vai armazenar o access_token do usuário |
| refresh_token_name | @refresh_token | Nome da key no local storage que vai armazenar o refresh_token do usuário |
| refreshTokenUrl | /refresh-token | Endpoint da api que será usado para fazer a atualização do acces_token do usuário |
| requestInterceptorConfig | - | Objeto que pode ser passado para o interceptor de todas requests |
| unauthenticatedPaths | '/login' | Conjunto de paths que representam as rotas não autenticadas no client-side. |
OAuth0
Para utilizar o módulo oauth0, inicialize uma instancia da sua api da seguinte forma
import { OAuth0 } from '@naveteam/pandora-frontend'
const options = { api_url: process.env.API_URL }
const instance = OAuth0.createInstance(options)O objeto de opções, pode receber os seguintes parâmetros:
| Parâmetro | Valor padrão | Descrição |
|---|---|---|
| api_url | - | URL base da api que será utilizada |
| token_name | @token | Nome da key no local storage que vai armazenar o token do usuário |
| requestInterceptorConfig | - | Objeto que pode ser passado para o interceptor de todas requests |
| unauthenticatedPaths | '/login' | Conjunto de paths que representam as rotas não autenticadas no client-side. |
✨ Contribuidores
Obrigado a essas maravilhosas pessoas que contribuíram de alguma maneira para o desenvolvimento da lib (emoji key):
Esse projeto segue a especificação de all-contributors. Qualquer tipo de contribuição será bem-vinda!
Licença
MIT © Nave Team