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

# Dropbox Entities コレクション

`dropboxEntities` は、Dropbox 同期がプロジェクトと 1 人のユーザーの Dropbox との間でコピーしたファイルごとに 1 つのドキュメントと、短期間だけ存在する tombstone を保持します。このコレクションは Dropbox 同期に属します。third-party-datastore（`services/third-party-datastore/app/js/StateManager.mjs`）が書き込みと読み取りを行い、web モジュール `dropbox`（`services/web/modules/dropbox/app/src/DropboxHandler.mjs`）が削除します。Mongoose スキーマはありません。

#### フィールド

| フィールド | 型 | 意味 | ソース |
| - | - | - | - |
| `_id` | ObjectId | 挿入時にドライバーが設定します。 | `StateManager.mjs:46,97` |
| `overleaf.userId` | ObjectId | そのファイルがある Dropbox の持ち主であるユーザー。すべてのドキュメントに設定されます。 | `StateManager.mjs:48,98` |
| `overleaf.projectId` | ObjectId | doc またはファイルのプロジェクト。判明している場合に設定され、tombstone にはありません。 | `StateManager.mjs:49-51` |
| `overleaf.id` | ObjectId | プロジェクトの `rootFolder` 内の doc またはファイルの `_id`。判明している場合に設定されます。 | `StateManager.mjs:52` |
| `overleaf.type` | String | `doc` または `file`。現在のコードは書き込みますが読み取りません。 | `StateManager.mjs:53`。値は `services/web/app/src/Features/ThirdPartyDataStore/TpdsUpdateSender.mjs:35,96` と `UpdateMerger.mjs:104,119` から |
| `dropbox.id` | String | Dropbox のファイルメタデータにおけるファイルの `id`。tombstone には設定されません。 | `StateManager.mjs:56` |
| `dropbox.pathLower` | String | Dropbox 内のファイルのパス。小文字で、末尾のスラッシュはありません。ファイルまたはそのプロジェクトフォルダーが移動すると更新されます。 | `StateManager.mjs:14-16,57,91,99` |
| `dropbox.rev` | String | 最後の同期時の Dropbox リビジョン。次のアップロードでこれを送信するため、Dropbox で変更されたファイルは上書きされません。 | `StateManager.mjs:58`、`JobProcessor.mjs:114-122` |
| `dropbox.contentHash` | String | 最後の同期時の Dropbox コンテンツハッシュ。同じハッシュの一覧内ファイルは、自分自身のアップロードか適用済みのためスキップされます。 | `StateManager.mjs:59`、`PullManager.mjs:147-149` |
| `tombstone` | Boolean | `true` は、third-party-datastore 自身が Dropbox で削除または移動したパスを示します。Dropbox がその削除を報告してきても、プロジェクトには適用されません。 | `StateManager.mjs:100`、`PullManager.mjs:189-192` |
| `createdAt` | Date | tombstone のみ：作成日時。完了した pull は、その開始前に作られた tombstone を削除します。 | `StateManager.mjs:101,115-121` |

tombstone には `overleaf.userId`、`dropbox.pathLower`、`tombstone`、`createdAt` だけがあります（`StateManager.mjs:96-103`）。

#### 書き込み元

| コード | 処理内容 |
| - | - |
| `services/third-party-datastore/app/js/StateManager.mjs:35-62`（`recordEntity`） | 同じ `dropbox.id`、`dropbox.pathLower`、`overleaf.id` を持つユーザーのドキュメントを削除してから、新しい状態を挿入します。 |
| `services/third-party-datastore/app/js/JobProcessor.mjs:102-134`（`addEntity`） | Overleaf から Dropbox へアップロードした後に doc またはファイルを記録します（`:125-133`）。 |
| `services/third-party-datastore/app/js/PullManager.mjs:142-177`（`applyFile`） | web がプロジェクトに適用した後に Dropbox のファイルを記録します（`:168-176`）。 |
| `StateManager.mjs:80-94`（`moveEntities`） | 移動したパス配下の `dropbox.pathLower` を書き換えます：プロジェクト名の変更（`JobProcessor.mjs:195`）とファイルまたはフォルダーの移動（`JobProcessor.mjs:239`）。 |
| `StateManager.mjs:96-103`（`addTombstone`） | Dropbox での削除（`JobProcessor.mjs:153`）、プロジェクト名の変更（`:202`）、移動（`:240`）の後。 |
| `StateManager.mjs:72-78`（`removeEntities`） | tombstone を除き、パスとその配下のエントリを削除します：Overleaf からの削除（`JobProcessor.mjs:152`）または Dropbox での削除（`PullManager.mjs:206`）の後。 |
| `StateManager.mjs:115-121`（`clearTombstones`） | pull の最後に実行します（`PullManager.mjs:31,69`）。 |
| `StateManager.mjs:186-190`（`removeUserState`）、`services/third-party-datastore/app/js/QueueWorker.mjs:43` から呼び出し | third-party-datastore がもう使えないアカウントのリンクを解除するとき、そのユーザーのドキュメントをすべて削除します。 |
| `DropboxHandler.mjs:142-146`（`removeUserState`） | リンク時（`:125`）、リンク解除時（`:183`）、削除済みユーザーの期限切れ時（`services/web/modules/dropbox/index.mjs:62-64`）に、そのユーザーのドキュメントをすべて削除します。 |
| `DropboxHandler.mjs:150-154`（`removeProjectState`） | 削除済みプロジェクトの期限切れ時に、そのプロジェクトのドキュメントを削除します（`index.mjs:54-56`）。 |

#### 読み取り元

| コード | 処理内容 |
| - | - |
| `StateManager.mjs:64-70`（`findEntityByPath`） | アップロード前に `dropbox.rev` を（`JobProcessor.mjs:114`）、Dropbox のファイルを適用する前に `dropbox.contentHash` を取得します（`PullManager.mjs:147`）。 |
| `StateManager.mjs:106-112`（`findTombstone`） | 報告された削除を、そのパスまたは親パスについて確認します（`PullManager.mjs:189`）。 |
| `StateManager.mjs:160-175`（`getSyncedPaths`） | カーソルのリセット後に同期済みファイルのパスを一覧にし、一覧にないファイルを削除済みとして扱えるようにします（`PullManager.mjs:74-85`）。 |

#### インデックス

| 名前 | キー | オプション | マイグレーション |
| - | - | - | - |
| `_id_` | `_id: 1` | | default |
| `overleaf_userId_1_overleaf_projectId_1` | `overleaf.userId: 1, overleaf.projectId: 1` | | `tools/migrations/20250130104049_create_dropboxEntities_userId_projectId_index.mjs` |

`20220811111800_create_dropboxEntities_index.mjs` と `20220825160708_recreate_dropboxEntities.mjs` には `saas` タグしかないため、CE には `(overleaf.userId, dropbox.id)` と `(overleaf.userId, overleaf.id)` のユニークインデックスも、`dropbox.pathLower` のハッシュインデックスもありません。

#### 注意事項

* 一意性は、`recordEntity` で各挿入の前に行う削除だけによって保たれます（`StateManager.mjs:38-45`）。`StateManager.mjs:3-11` のコメントはユニークインデックスに触れていますが、CE にはありません。
* ユーザーとパスによるクエリ（`findEntityByPath`、`findTombstone`、`removeEntities`）は、`overleaf.userId` についてのみインデックスを使います。


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