Глосарій
Терміни і абревіатури з домену проєкту. Глобальні — тут. Сервіс-специфічні — у локальному glossary.md відповідного сервісу.
Доменні
| Термін | Значення |
|---|---|
| RU | Чоловік — клієнт сайту |
| TU | Анкета, жінка, леді — профіль від імені якого працює оператор |
| LT | Lifetime — кількість днів відколи RU зробив першу витрату по TU |
| LT day: N | Поточне значення lifetime для пари RU↔TU |
| Connection (Conn) | Пара TU↔RU з хоч однією витратою. Категорії за LT: New = LT0 (день знайомства), Young = LT1–7, Old = LT8+ |
| Chat / Mail / Email | Три режими переписки з RU (на сайті — Chat і Mail; Email — особиста gmail-скринька TU) |
| Invite | Шаблон повідомлення який Sender використовує для авторозсилки |
| Task | Завдання оператора зробити дію (зазвичай — написати) яке створюється за різних умов |
| Sender | Система автоматичної розсилки інвайтів |
| Workspace | Робоча вкладка оператора у electron-клієнті — листування, фаворити, таски |
| Whitelist | Список RU яким можна слати інвайт (антипод blacklist) |
| Family | Один із 4-х партнерських проєктів — golden, prime, udate, chathouse. Базова одиниця сегментації даних і ролей |
| Stack Lady | Картка клієнтки на рівні stack (mongo stack_ladies); одна Stack Lady може мати кілька Family-профілів |
| Lady Legend | Структурована «легенда» TU (lifestyle, character, family, hobby, plans) — фон, який оператор підтримує у переписці |
| Note | Замітка оператора по парі TU↔RU |
| AI Note | Замітка згенерована AI; модерується супервайзером |
| Ticket | Сутність-задача всередині системи з призначенням, статусами, дедлайном (поза тасками операторів) |
| Card | Картка кандидата в воронці рекрутингу |
| Trainee / Mentor / Course | Сутності внутрішньої академії |
Сегменти і жаргон
| Термін | Значення |
|---|---|
| Profit | Сума витрат RU на TU ($) — основний бізнес-показник пари |
| Gifts | Кількість віртуальних подарунків від RU до TU |
| Active Favorite | RU що нещодавно платив (за спецправилом) — важливіша підкатегорія Favorites |
| Freeloader | Жаргон для RU що «не платить» |
Ідентифікатори
Декілька різних ID які описують один і той же субʼєкт у різних системах — постійно плутають.
| Термін | Значення |
|---|---|
| stackLadyId | Mongo-ID запису в stack_ladies |
| id_api / ladyId_api / manId_api | ID профілю в API партнерського сайту (НЕ mongo) |
| adminId_api | id_api адміна на партнерському сайті, якому належить TU |
| operatorFamilyId | Mongo-ID запису Family оператора (один на пару Family×User); ключ маршрутизації подій |
| stackOperatorId | ID юзера |
Партнерські сайти
| Термін | Значення |
|---|---|
| Golden / Goldenbride | Партнер №1, бек у stack-golden |
| Prime | Партнер з VIP-механікою, newsfeed, icebreakers; бек у stack-prime |
| Udate | Партнер з окремим бекендом (GraphQL, ULID-и); stack-udate |
| Chathouse | Партнер з auth_codes-сесіями і icebreakers; stack-chathouse |
| Talkytimes | Зустрічається у коді (папки talkytimes/, константи TALKYTIMES_*) як назва для Prime. TODO: визначити фінальну назву (prime чи talkytimes) і уніфікувати у коді й документації. |
Зовнішні системи / API
| Термін | Значення |
|---|---|
| Official API | Зовнішнє HTTP-API партнерського сайту (списки, фінанси, чат-історія) |
| DeepL | Зовнішній сервіс перекладу (UK/RU/EN) |
| Gmail (sync) | Інтеграція особистих email-скриньок TU через Gmail API |
| Gemini | LLM-провайдер для AI Legend |
| ClickHouse | Аналітичне сховище для метрик |
| Telegram bots | @BeSocialHR_bot для HR-кандидатів та інші |
Ролі
Ролі перевіряються через guard([StackRoles.<name>]) у бек-сервісах. Описуємо коротко — детальні бізнес-правила лишаємо коду і Swagger-у.
| Роль (код) | Кому | Призначення |
|---|---|---|
director | Керівництво | Найвищий рівень доступу. Може все що обмежено цією роллю в Swagger. (TODO: уточнити обсяг) |
topManager | Топ-менеджмент агенції | (TODO) |
supervisor | Супервайзер операторів | У розмові — «тімлід»; як StackRole — лише supervisor (team_lead як ідентифікатор не вживається) |
client_manager | Менеджер клієнток (CM) | (TODO) |
operator | Оператор electron-клієнта | Основний користувач stack-electron. Викликає /golden/electron-api/*. |
hr | HR-департамент | (TODO: уточнити обсяг — ймовірно секції академії та кандидатів) |
recruiter | Рекрутер | (TODO: уточнити — рекрутингова воронка, картки кандидатів) |
technical_department | Технічний департамент | (TODO: уточнити — ймовірно адмін-доступ до системних розділів) |
Технічно: enum StackRoles живе в stack-commons; на ендпоінті — @UseBefore(guard([StackRoles.<name>, ...])); без потрібної ролі → HTTP 400 + {success:false, data:{message:'Not allow role'}}; без токена → 401; guard([]) — будь-який авторизований. Перелік ендпоінтів, захищених кожною роллю — у Swagger UI відповідного сервісу, тут не дублюємо.
Нова роль: значення в enum StackRoles (stack-commons) → рядок у таблиці вище.
Сервіси (короткий покажчик)
Повна мапа — у Architecture.
| Сервіс | Призначення |
|---|---|
stack | Точка входу, оркестратор, основний веб-сервер |
stack-client | Веб-фронт |
stack-electron | Електрон-програма оператора |
stack-golden | Бек по проєкту goldenbride |
stack-prime | Бек по проєкту prime |
stack-udate | Бек по проєкту udate |
stack-chathouse | Бек по проєкту chathouse |
stack-academy | Внутрішня школа |
stack-ai | AI-сервіс (легенди, переклади) |
stack-commons | Спільні утиліти, middleware, types |
Runtime / процеси
| Термін | Значення |
|---|---|
| OperatorRunner | Корневий runtime в електроні per авторизований оператор |
| LadyRunner | Per-TU runtime — підтримує сесію в сайт, чергу чату, sender’и, таски |
| Chat Sender / Mail Sender | Авто-сервіси що дрейнять інвайти і відправляють по сайт-API |
| Workspace streaming | Live-спостереження тімліда за поточним екраном оператора (socket-проксі) |
Технічне
| Термін | Значення |
|---|---|
| Swagger UI v2 | Auto-generated Swagger з routing-controllers, доступний на /<service>/api-docs/v2 |
| Legacy controller | Контролер на BaseController + bindRoutes — поза auto-Swagger, поступово мігруємо на routing-controllers |
| Routing-controllers | Декораторний підхід (@JsonController, @Get, @UseBefore) — джерело Swagger v2 |
| Family-prefixed модель | Конвенція mongo-моделей: golden_lady, prime_lady, chathouse_tasks, golden_send_mail_history тощо |
| assignments | Прив’язка одного користувача до однієї або кількох ролей у різних Families (IUserRoleAssignment) |
| RMQ | RabbitMQ — асинхронна шина між сервісами |
| Vault | Папка яка відкривається в Obsidian як єдина база |
| Quartz | Статичний сайт-генератор яким рендеримо vault на сайт |