omega-auth v0.0.7

Модуль авторизации и регистрации

Как подключиться к модулю:

Пример:

Настройка модуля:

В папке config лежат все конфиги для настройки для модуля:

1. auth.js - настройки модуля auth
2. email.js - настройки email-рассылки

Настраиваем auth.js

1. обязательно указать названия полей вашей коллекции пользователей в userFields
2. в confirmCodeExpiryPeriod можно указать свое значение актуальности ключа подтверждения пользователя
3. в emailNotifications указывается каким методам разрешене email-рассылка
4. в APIError настроены стандартные ответы модуля на ошибки, первый аргумент указывает на http-статус, возвращаемый модулем, а второй - описание ошибки. По желанию можете указать свое описание ошибок.

ВАЖНО: для стабильной работы модуля не рекомендуется удалять какие-либо из настроек auth.js, т.к. это повлечет за собой падение сервера в целом

Настраиваем email.js

1. в emailTrasporter указываем от кого будет приходить email-рассылка: имя и почта
2. в emailSubjects указываем темы сообщений email для каждого случая

ВАЖНО: так же, как и для auth.js, в config.js не рекомендуется удалять настройки

Для email-рассылки предусмотрены стандартные шаблоны, которые можно найти в папке templates. Их можно отредактировать по своему усмотрению. Если какой-то параметр указан в квадратный скобках (например, confirmCode), это означает, что вместо этого параметра поставляется какое-то значение, т.е. работает парсер - следите за этим.

Описание методов:

1. register - регистрация пользователя с возможностью email-уведомления
2. login - вход в приложение
3. changePassword - смена пароя с возможностью email-уведмления
4. changeEmail - смена email с email-уведомлением
5. confirm - подтверждение пользователя
6. restorePassword - функция ресета пароля, если его забыли, с email-уведмолением
7. restoreConfirmCode - функция ресета confirmCode, если по каким-то причинам не дошел старый или он просрочен, с email-уведмолением