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

# Coleção Project Invites

`projectInvites` contém os convites que o dono de um projeto envia a partir da caixa de diálogo de partilha. Um documento é um convite para um endereço de email. É apagado quando o convite é aceite ou revogado, ou pelo Mongo quando expira. O esquema é `services/web/app/src/models/ProjectInvite.mjs`, e quem o escreve é `services/web/app/src/Features/Collaborators/CollaboratorsInviteHandler.mjs`.

Um convite não torna ninguém membro. Os membros estão nos arrays `*_refs` de um projeto, veja [Coleção Projects](https://ayakaleaf-pro.mintlify.site/pt/dev/data-model/projects-collection.md).

#### Campos

| Campo | Tipo | Significado | Origem |
| - | - | - | - |
| `_id` | ObjectId | Id do convite. A notificação de convite de um utilizador existente usa a chave `project-invite-<_id>` (`services/web/app/src/Features/Notifications/NotificationsBuilder.mjs:102`). | `ProjectInvite.mjs:14` |
| `email` | String | Endereço para onde o convite foi enviado. Ao revogar um convite para um utilizador, é comparado com os emails confirmados do utilizador (`CollaboratorsInviteHandler.mjs:103-116`). Não definido num convite por link de partilha. | `ProjectInvite.mjs:16`, `CollaboratorsInviteHandler.mjs:84` |
| `tokenHmac` | String | HMAC-SHA256 (chave `overleaf-token-invite`) do token no link do convite. O token em texto simples só está no email e na notificação; as pesquisas aplicam hash ao token do URL e comparam-no com este campo. | `ProjectInvite.mjs:18`, `services/web/app/src/Features/Collaborators/CollaboratorsInviteHelper.mjs:11-15`, `CollaboratorsInviteHandler.mjs:82,256` |
| `encryptedToken` | String | Apenas em convites por link de partilha: o token, cifrado com `Settings.projectInviteEncryptorOptions`, para que o dono possa voltar a ver o link (`services/web/app/src/Features/Collaborators/CollaboratorsInviteController.mjs:606-611`). | `ProjectInvite.mjs:17`, `CollaboratorsInviteHelper.mjs:30-47`, `CollaboratorsInviteHandler.mjs:255-258` |
| `sendingUserId` | ObjectId | Utilizador que enviou o convite. Ao aceitar, é passado como o utilizador que adicionou o novo membro (`CollaboratorsInviteHandler.mjs:199-205`). Não definido num convite por link de partilha. | `ProjectInvite.mjs:19`, `CollaboratorsInviteHandler.mjs:86` |
| `projectId` | ObjectId | Projeto a que o convite se refere. | `ProjectInvite.mjs:20`, `CollaboratorsInviteHandler.mjs:87` |
| `privileges` | String or Boolean | Acesso que o convidado recebe: `readOnly`, `readAndWrite` ou `review` (`services/web/app/src/Features/Authorization/PrivilegeLevels.mjs:6-12`). Um convite por link de partilha também pode conter `false`, ou seja, sem acesso. | `ProjectInvite.mjs:21-25`, `CollaboratorsInviteHandler.mjs:88` |
| `createdAt` | Date | Definido pelo valor predefinido do esquema quando o convite é guardado. | `ProjectInvite.mjs:26` |
| `expires` | Date | Valor predefinido do esquema: 30 dias após a criação. O índice TTL remove o convite cerca de 10 segundos depois deste momento. `null` num convite por link de partilha, que nunca expira. | `ProjectInvite.mjs:6-12,27-31`, `CollaboratorsInviteHandler.mjs:264` |
| `reusable` | Boolean | `false` num convite por email, que é apagado quando aceite (`CollaboratorsInviteHandler.mjs:207-220`). `true` num convite por link de partilha, que se mantém. | `ProjectInvite.mjs:32`, `CollaboratorsInviteHandler.mjs:89,263` |
| `subscriptionId` | ObjectId | Apenas em convites por link de partilha: a subscrição de grupo cujos membros podem aceitar o link (`CollaboratorsInviteController.mjs:490-501`). | `ProjectInvite.mjs:33`, `CollaboratorsInviteHandler.mjs:262` |

#### Quem escreve

| Código | O que faz |
| - | - |
| `CollaboratorsInviteHandler.mjs:76-101` (`inviteToProject`) | Cria um convite por email e depois envia o email e, para um utilizador existente, uma notificação. Chamado por `POST /project/:Project_id/invite` (`services/web/app/src/Features/Collaborators/CollaboratorsRouter.mjs:114-125`). |
| `CollaboratorsInviteHandler.mjs:118-133` (`revokeInvite`) | Apaga um convite e marca a sua notificação como lida. Chamado por `DELETE /project/:Project_id/invite/:invite_id` (`CollaboratorsRouter.mjs:154-159`). |
| `CollaboratorsInviteHandler.mjs:135-153` (`generateNewInvite`) | Reenviar: apaga o convite e cria um novo com um novo token (`CollaboratorsRouter.mjs:161-169`). |
| `CollaboratorsInviteHandler.mjs:103-116` (`revokeInviteForUser`) | Apaga o convite enviado para um dos emails confirmados do utilizador, quando o utilizador entra através de um token de partilha por link (`services/web/app/src/Features/TokenAccess/TokenAccessController.mjs:396-401`) ou recebe acesso após um pedido de acesso (`services/web/app/src/Features/Collaborators/CollaboratorsController.mjs:503-513`). |
| `CollaboratorsInviteHandler.mjs:155-221` (`acceptInvite`) | Adiciona o utilizador ao projeto e depois apaga o convite, a menos que seja `reusable`. |
| `CollaboratorsInviteHandler.mjs:249-269` (`createSharingLinkInvite`), `CollaboratorsInviteController.mjs:689-724` (`updateSharingLink`) | Criam ou atualizam o único convite reutilizável por link de partilha de um projeto. Estas rotas exigem o split test `sharing-updates-new-link` (`CollaboratorsRouter.mjs:134-152`), que não está em `splitTestOverrides` (`services/web/config/settings.defaults.js:1371-1383`). Por isso respondem 403 enquanto esse split test não estiver configurado. |

#### Quem lê

| Código | O que faz |
| - | - |
| `services/web/app/src/Features/Collaborators/CollaboratorsInviteGetter.mjs:6-19` (`getAllInvites`) | Lista os convites por email pendentes para a caixa de diálogo de partilha (`GET /project/:Project_id/invites`, `CollaboratorsRouter.mjs:127-132`). Ignora os convites reutilizáveis. |
| `CollaboratorsInviteGetter.mjs:21-29` (`getEditInviteCount`) | Conta os convites por email pendentes que não são `readOnly`. `services/web/app/src/Features/Subscription/LimitationsManager.mjs:61-70` soma-os aos editores quando verifica o limite de colaboradores. |
| `CollaboratorsInviteGetter.mjs:31-44` (`getInviteByToken`) | Encontra um convite pelo hash do token no URL, para a página do convite e para aceitar (`CollaboratorsInviteController.mjs:353,481`). |
| `CollaboratorsInviteGetter.mjs:46-70` | Encontra o convite por link de partilha de um projeto. |

#### Índices

| Nome | Chaves | Opções | Migração |
| - | - | - | - |
| `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` |

As migrações estão em `tools/migrations/`. O esquema também declara o índice TTL de `expires`, mas o `autoIndex` do Mongoose está desativado (`services/web/app/src/infrastructure/Mongoose.mjs:7`), por isso é a migração que o cria.

#### Notas

* Se o projeto não tiver nenhum lugar de editor livre quando um convite `readAndWrite` ou `review` for aceite, o utilizador entra só com leitura e fica listado em `pendingEditor_refs` ou `pendingReviewer_refs` do projeto (`CollaboratorsInviteHandler.mjs:162-205`).
* Os convites mais antigos guardavam o token em texto simples num campo `token`. A migração `20240524135408_add_token_hmac_project_invite_tokens.mjs` adicionou `tokenHmac` e `20240531082910_remove_project_invite_tokens.mjs` removeu `token`.
* Nada apaga os convites de um projeto eliminado; ficam até o índice TTL os remover.


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