> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Колекція Project Invites

`projectInvites` зберігає запрошення, які власник проєкту надсилає з вікна спільного доступу. Один документ відповідає одному запрошенню на одну адресу email. Документ видаляється, коли запрошення прийнято або відкликано, або Mongo видаляє його після закінчення строку. Схема: `services/web/app/src/models/ProjectInvite.mjs`, а записує її `services/web/app/src/Features/Collaborators/CollaboratorsInviteHandler.mjs`.

Запрошення нікого не робить учасником. Учасники зберігаються в масивах `*_refs` проєкту, див. [Колекція Projects](https://ayakaleaf-pro.mintlify.site/uk/dev/data-model/projects-collection.md).

#### Поля

| Поле | Тип | Значення | Джерело |
| - | - | - | - |
| `_id` | ObjectId | Id запрошення. Сповіщення про запрошення для наявного користувача використовує ключ `project-invite-<_id>` (`services/web/app/src/Features/Notifications/NotificationsBuilder.mjs:102`). | `ProjectInvite.mjs:14` |
| `email` | String | Адреса, на яку надіслано запрошення. Під час відкликання запрошення для користувача її порівнюють із підтвердженими адресами користувача (`CollaboratorsInviteHandler.mjs:103-116`). Не задається для запрошення за посиланням спільного доступу. | `ProjectInvite.mjs:16`, `CollaboratorsInviteHandler.mjs:84` |
| `tokenHmac` | String | HMAC-SHA256 (ключ `overleaf-token-invite`) токена з посилання запрошення. Вихідний токен є лише в листі й сповіщенні; під час пошуку токен з URL хешується і порівнюється з цим полем. | `ProjectInvite.mjs:18`, `services/web/app/src/Features/Collaborators/CollaboratorsInviteHelper.mjs:11-15`, `CollaboratorsInviteHandler.mjs:82,256` |
| `encryptedToken` | String | Лише для запрошень за посиланням спільного доступу: токен, зашифрований з `Settings.projectInviteEncryptorOptions`, щоб власник міг знову побачити посилання (`services/web/app/src/Features/Collaborators/CollaboratorsInviteController.mjs:606-611`). | `ProjectInvite.mjs:17`, `CollaboratorsInviteHelper.mjs:30-47`, `CollaboratorsInviteHandler.mjs:255-258` |
| `sendingUserId` | ObjectId | Користувач, який надіслав запрошення. Під час прийняття передається як користувач, що додав нового учасника (`CollaboratorsInviteHandler.mjs:199-205`). Не задається для запрошення за посиланням спільного доступу. | `ProjectInvite.mjs:19`, `CollaboratorsInviteHandler.mjs:86` |
| `projectId` | ObjectId | Проєкт, якого стосується запрошення. | `ProjectInvite.mjs:20`, `CollaboratorsInviteHandler.mjs:87` |
| `privileges` | String or Boolean | Доступ, який отримує запрошений: `readOnly`, `readAndWrite` або `review` (`services/web/app/src/Features/Authorization/PrivilegeLevels.mjs:6-12`). Запрошення за посиланням спільного доступу може також містити `false`, тобто відсутність доступу. | `ProjectInvite.mjs:21-25`, `CollaboratorsInviteHandler.mjs:88` |
| `createdAt` | Date | Задається типовим значенням зі схеми під час збереження запрошення. | `ProjectInvite.mjs:26` |
| `expires` | Date | Типове значення зі схеми: через 30 днів після створення. TTL-індекс видаляє запрошення приблизно через 10 секунд після цього часу. `null` для запрошення за посиланням спільного доступу, яке ніколи не спливає. | `ProjectInvite.mjs:6-12,27-31`, `CollaboratorsInviteHandler.mjs:264` |
| `reusable` | Boolean | `false` для запрошення email, яке видаляється після прийняття (`CollaboratorsInviteHandler.mjs:207-220`). `true` для запрошення за посиланням спільного доступу, яке залишається. | `ProjectInvite.mjs:32`, `CollaboratorsInviteHandler.mjs:89,263` |
| `subscriptionId` | ObjectId | Лише для запрошень за посиланням спільного доступу: групова підписка, учасники якої можуть прийняти посилання (`CollaboratorsInviteController.mjs:490-501`). | `ProjectInvite.mjs:33`, `CollaboratorsInviteHandler.mjs:262` |

#### Хто записує

| Код | Що робить |
| - | - |
| `CollaboratorsInviteHandler.mjs:76-101` (`inviteToProject`) | Створює запрошення email, потім надсилає лист і, для наявного користувача, сповіщення. Викликається з `POST /project/:Project_id/invite` (`services/web/app/src/Features/Collaborators/CollaboratorsRouter.mjs:114-125`). |
| `CollaboratorsInviteHandler.mjs:118-133` (`revokeInvite`) | Видаляє одне запрошення і позначає його сповіщення прочитаним. Викликається з `DELETE /project/:Project_id/invite/:invite_id` (`CollaboratorsRouter.mjs:154-159`). |
| `CollaboratorsInviteHandler.mjs:135-153` (`generateNewInvite`) | Повторне надсилання: видаляє запрошення і створює нове з новим токеном (`CollaboratorsRouter.mjs:161-169`). |
| `CollaboratorsInviteHandler.mjs:103-116` (`revokeInviteForUser`) | Видаляє запрошення, надіслане на одну з підтверджених адрес користувача, коли користувач приєднується за токеном спільного доступу за посиланням (`services/web/app/src/Features/TokenAccess/TokenAccessController.mjs:396-401`) або отримує доступ після запиту доступу (`services/web/app/src/Features/Collaborators/CollaboratorsController.mjs:503-513`). |
| `CollaboratorsInviteHandler.mjs:155-221` (`acceptInvite`) | Додає користувача до проєкту, потім видаляє запрошення, якщо воно не `reusable`. |
| `CollaboratorsInviteHandler.mjs:249-269` (`createSharingLinkInvite`), `CollaboratorsInviteController.mjs:689-724` (`updateSharingLink`) | Створюють або оновлюють єдине багаторазове запрошення за посиланням спільного доступу для проєкту. Ці маршрути потребують split test `sharing-updates-new-link` (`CollaboratorsRouter.mjs:134-152`), якого немає в `splitTestOverrides` (`services/web/config/settings.defaults.js:1371-1383`). Тому вони відповідають 403, доки цей split test не налаштовано. |

#### Хто читає

| Код | Що робить |
| - | - |
| `services/web/app/src/Features/Collaborators/CollaboratorsInviteGetter.mjs:6-19` (`getAllInvites`) | Виводить очікувані запрошення email у вікні спільного доступу (`GET /project/:Project_id/invites`, `CollaboratorsRouter.mjs:127-132`). Пропускає багаторазові запрошення. |
| `CollaboratorsInviteGetter.mjs:21-29` (`getEditInviteCount`) | Рахує очікувані запрошення email, які не `readOnly`. `services/web/app/src/Features/Subscription/LimitationsManager.mjs:61-70` додає їх до редакторів під час перевірки ліміту співавторів. |
| `CollaboratorsInviteGetter.mjs:31-44` (`getInviteByToken`) | Знаходить запрошення за хешем токена з URL для сторінки запрошення і для прийняття (`CollaboratorsInviteController.mjs:353,481`). |
| `CollaboratorsInviteGetter.mjs:46-70` | Знаходить запрошення за посиланням спільного доступу для проєкту. |

#### Індекси

| Назва | Ключі | Параметри | Міграція |
| - | - | - | - |
| `expires_1` | `{ expires: 1 }` | TTL, `expireAfterSeconds: 10` | `20190912145023_create_projectInvites_indexes.mjs` |
| `projectId_1` | `{ projectId: 1 }` | | `20190912145023_create_projectInvites_indexes.mjs` |
| `tokenHmac_1` | `{ tokenHmac: 1 }` | | `20240524135408_add_token_hmac_project_invite_tokens.mjs` |

Міграції містяться в `tools/migrations/`. Схема теж оголошує TTL-індекс на `expires`, але `autoIndex` у Mongoose вимкнено (`services/web/app/src/infrastructure/Mongoose.mjs:7`), тому індекс створює міграція.

#### Примітки

* Якщо під час прийняття запрошення `readAndWrite` або `review` у проєкті не залишилося вільних місць для редакторів, користувач приєднується лише з правом читання і потрапляє до `pendingEditor_refs` або `pendingReviewer_refs` проєкту (`CollaboratorsInviteHandler.mjs:162-205`).
* Старі запрошення зберігали вихідний токен у полі `token`. Міграція `20240524135408_add_token_hmac_project_invite_tokens.mjs` додала `tokenHmac`, а `20240531082910_remove_project_invite_tokens.mjs` видалила `token`.
* Ніщо не видаляє запрошення видаленого проєкту; вони залишаються, доки їх не видалить TTL-індекс.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.