> ## 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/ru/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.