@webdevep/auth-modul-vue v2.3.4

Модуль для фронтэнда на vue, работающий с сервисом авторизации

Ссылка для скачивания данной документации https://modules.dev-webdevep.ru/auth-front-moduls/VUE.md

Установка npm модуля

Для установки через npm, выполните команду:

npm i @webdevep/auth-modul-vue

Работа с модулем

Параметры модуля

• baseUrl - Урл сервера (используется в fetch)
• lifeTimeToken - Время жизни токена в МИНУТАХ
• lifeTimeTokenWithRemember - Время жизни токена в МИНУТАХ (если выбрали запомнить меня)
• lifeTimeRefreshToken - Время жизни refresh токена в МИНУТАХ
• lifeTimeRefreshTokenWithRemember - Время жизни refresh токена в МИНУТАХ (если выбрали запомнить меня)

import { AuthModule } from "@webdevep/auth-modul-vue";

const authModule = new AuthModule({
  baseUrl: process.env.VUE_APP_AUTH_URL,
  lifeTimeToken: 180, // по умолчанию
  lifeTimeTokenWithRemember: 720, // по умолчанию
  lifeTimeRefreshToken: 1440, // по умолчанию
  lifeTimeRefreshTokenWithRemember: 43200, // по умолчанию
});

Публичные методы модуля

async sendConfirmCode

Отправляется код подтверждения на телефон перед логином/регистрацией

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async login

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async register

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async loginOrRegister

Происходит попытка входа, при ошибке - регистрация нового пользователя

Аргументы:

• data - object
• registerData - object

Возвращаемое значение: response.data - object

async logout

Аргументы:

• refreshToken - string (необязательный)

Возвращаемое значение: _

async getUserId

Возращает userId, полученный из accessToken

Аргументы:

• accessToken - string (необязательный)
• publicKeyData - object (необязательный)

Возвращаемое значение: userId - string

async getUserInfo

Аргументы:

• accessToken - string (необязательный)

Возвращаемое значение: response.data - object

async isAuth

Происходит верификация токена с проверкой даты окончания его действия, в случае успеха true. Если не пройдена - попытка сгенерировать новый токен. В случае успеха возвращается объект с токенами, иначе - false

Аргументы:

• accessToken - string (необязательный)
• refreshToken - string (необязательный)
• publicKeyData - object (необязательный)

Возвращаемое значение: isAuth - boolean|object

async refreshTokens

Принудительное обновление токенов

Аргументы:

• refreshToken - string (необязательный)

Возвращаемое значение: { ok: boolean, tokens: object }

async updateUserInfo

Аргументы:

• userinfo - object
• accessToken - string (необязательный)

Возвращаемое значение: response.data - object

async changeLogin

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async sendEmailConfirmationLink

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async sendPasswordResetLink

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async confirmEmail

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async confirmPhone

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async getOAuthLink

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async oauthLogin

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async telegramLogin

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async resetPassword

Аргументы:

• data - object

Возвращаемое значение: response.data - object

async getRecaptchaSiteKey

Аргументы: _

Возвращаемое значение: response.data - object

async loadRecaptcha

Аргументы:

• storeRecaptcha - boolean

Возвращаемое значение: Promise

async getRecaptcha

Аргументы: _

Возвращаемое значение: Promise

setRemember

Аргументы:

• remember - boolean

Возвращаемое значение: _

Необязательные параметры

• accessToken - string (необязательный)
• refreshToken - string (необязательный)
• publicKeyData - object (необязательный) Если эти необязательные параметры не переданы, они берутся из cookie

Модуль доступен в React Native и в js. Происходит проверка наличия глобального объекта document, если он найдет токены хранятся в cookie, иначе не записывает