@yourgoods/auth-sdk NPM

Auth-Service: SDK

Содержание

О проекте
Архитектура и логика работы
- 1. Основы
- 3. Особенности проекта
  - 3.1 Типизация
Локальный запуск
Start Guide
- 1. Публикация
Мониторинг, Логгирование и отлов ошибок

О проекте

Это SDK для работы с бэкендом авторизации

Архитектура и логика работы

1. Основы

Проект является npm пакетом

3. Особенности проекта

3.1 Типизация

При добавлении метода, нужно всегда указывать что он возвращает. Иначе при его сборке и использовании, будет просто возвращаться "?" вместо типа.

Локальный запуск

Для локальной разработки есть 2 папки: playgroundCJS и playgroundESM.\ Для взаимодействия сначала делаем npm run build, потом node ./playgroundESM/index.mjs (или CJS)

Если нужно подключить локальную библиотеку к какому-нибудь проекту, сделать это можно через npm link\ В директории Auth SDK выполняем команду npm link. Она создаст в глобаной директории symlink на текущую директорию. Посмотреть где находится эта директория можно через $(npm prefix -g)/lib/node_modules.

После этого заходим в проект, куда нужно импортировать либу и выполняем npm link @yourgoods/auth-sdk.

При изменении в коде Auth SDK, изменения должны сразу появляться в проекте

ВАЖНО для того чтобы npm link работал, нужно использовать одну и ту же версию npm в директории auth-sdk и сервиса куда подключается auth-sdk. Проверить это можно через which node, which npm.\ Тоже самое касается докера. Если в host системе сделан npm link, npm из докера ничего не будет знать про пакет.\ В таком случае backend сервиса нужно запускать без докера, а все остальное(базы, очереди) можно запускать в докере