> ## 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` には、プロジェクトのオーナーが共有ダイアログから送る招待が格納されます。1 つのドキュメントが、1 つのメールアドレスへの 1 件の招待です。招待が承諾または取り消されると削除され、期限が切れると Mongo によって削除されます。スキーマは `services/web/app/src/models/ProjectInvite.mjs` で、`services/web/app/src/Features/Collaborators/CollaboratorsInviteHandler.mjs` が書き込みます。

招待によって誰かがメンバーになるわけではありません。メンバーはプロジェクトの `*_refs` 配列にあります。[Projects コレクション](https://ayakaleaf-pro.mintlify.site/ja/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` で、承諾すると削除されます（`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`) | メールでの招待を作成し、メールを送信します。既存ユーザーには通知も送ります。`POST /project/:Project_id/invite` から呼び出されます（`services/web/app/src/Features/Collaborators/CollaboratorsRouter.mjs:114-125`）。 |
| `CollaboratorsInviteHandler.mjs:118-133` (`revokeInvite`) | 招待を 1 件削除し、その通知を既読にします。`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`) | プロジェクトに 1 つだけある再利用可能な共有リンクの招待を作成または更新します。これらのルートには split test `sharing-updates-new-link` が必要です（`CollaboratorsRouter.mjs:134-152`）。これは `splitTestOverrides` に含まれていないため（`services/web/config/settings.defaults.js:1371-1383`）、その split test を設定しない限り 403 を返します。 |

#### 読み取り元

| コード | 処理内容 |
| - | - |
| `services/web/app/src/Features/Collaborators/CollaboratorsInviteGetter.mjs:6-19` (`getAllInvites`) | 共有ダイアログ用に保留中のメール招待を一覧表示します（`GET /project/:Project_id/invites`、`CollaboratorsRouter.mjs:127-132`）。再利用可能な招待は除外します。 |
| `CollaboratorsInviteGetter.mjs:21-29` (`getEditInviteCount`) | `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/` にあります。スキーマでも `expires` の TTL インデックスを宣言していますが、Mongoose の `autoIndex` は無効なため（`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.