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

# Коллекция notifications

`notifications` хранит уведомления, которые показываются вверху панели проектов пользователя. Каждый документ описывает одно уведомление для одного пользователя и определяется своим `key`. Напрямую с коллекцией работает только сервис `notifications` (`services/notifications/app/js/Notifications.js`); `web` и `third-party-datastore` вызывают его HTTP API. Схемы Mongoose нет.

#### Поля

| Поле | Тип | Значение | Источник |
| - | - | - | - |
| `_id` | ObjectId | Id уведомления. `web` помечает уведомление прочитанным по этому id. | `Notifications.js:58-65` |
| `user_id` | ObjectId | Пользователь, который видит уведомление. | `Notifications.js:26` |
| `key` | String | Определяет уведомление, например `project-invite-<inviteId>`. Upsert сохраняет один документ на пару `user_id` и `key`; уникального индекса нет. | `Notifications.js:27`, `:51-55` |
| `templateKey` | String | Какое уведомление отображает фронтенд. Удаляется, когда уведомление прочитано или закрыто; сам документ остаётся. | `Notifications.js:29`, `:63`, `:72`, `:78` |
| `messageOpts` | Object | Значения для текста уведомления, зависящие от `templateKey` (для приглашения в проект: `userName`, `projectName`, `projectId`, `token`). Удаляется, когда пользователь закрывает уведомление по id. | `Notifications.js:28`, `:63` |
| `expires` | Date | Необязательно. TTL-индекс удаляет документ после этого момента. | `Notifications.js:35-50` |

#### Кто записывает

| Код | Что делает |
| - | - |
| `Notifications.js:20-56` (`addNotification`) | `POST /user/:user_id` (`services/notifications/app.ts:29`). Выполняет upsert по `user_id` + `key`. Если документ с таким ключом уже есть, он записывается повторно только тогда, когда вызывающий передаёт `forceCreate`. |
| `Notifications.js:58-65` (`removeNotificationId`) | `DELETE /user/:user_id/notification/:notification_id` (`app.ts:31-34`): удаляет `templateKey` и `messageOpts`. |
| `Notifications.js:67-80` | `DELETE /user/:user_id` и `DELETE /key/:key` (`app.ts:35-36`): удаляют `templateKey` по ключу. |
| `Notifications.js:87-100` | `DELETE /key/:key/bulk` (`app.ts:38-41`) удаляет непрочитанные уведомления с ключом; `deleteNotificationByKeyOnly` удаляет один документ по ключу. |
| `services/web/app/src/Features/Notifications/NotificationsHandler.mjs:33-66` | Сторона `web` для `addNotification`. Отправляет `forceCreate: true`, если вызывающий не передал `false`. |
| `services/third-party-datastore/app/js/QueueWorker.mjs:46-58` | Наша синхронизация с Dropbox: при отвязке аккаунта Dropbox напрямую публикует уведомление `dropbox-unlinked`. |

Уведомления, которые создают CE и наши модули:

| `key` | `templateKey` | Где создаётся |
| - | - | - |
| `project-invite-<inviteId>` | `notification_project_invite`, истекает вместе с приглашением | `services/web/app/src/Features/Collaborators/CollaboratorsInviteHandler.mjs:40-42`, собирается в `services/web/app/src/Features/Notifications/NotificationsBuilder.mjs:100-122`. Только если приглашённый адрес принадлежит существующему пользователю. |
| `tpdsFileLimit-<userId>` | `notification_tpds_file_limit` | `services/web/app/src/Features/ThirdPartyDataStore/TpdsController.mjs:118-124` (обновление из Dropbox превысило бы лимит файлов проекта), `NotificationsBuilder.mjs:175-195` |
| `dropboxDuplicateProjectNames-<userId>` | `notification_dropbox_duplicate_project_names` | `services/web/app/src/Features/ThirdPartyDataStore/TpdsUpdateHandler.mjs:160-169`, `NotificationsBuilder.mjs:10-30` |
| `dropbox-unlinked` | `dropbox_unlinked_because_access_denied`, `dropbox_unlinked_because_full` или `dropbox_unlinked_because_suspended` | `services/third-party-datastore/app/js/QueueWorker.mjs:20-25`, `:46-58` (наша синхронизация с Dropbox) |

`NotificationsBuilder.mjs` также собирает ключи для групповых приглашений, принадлежности к организациям, подписок и старых отладочных проектов. Их вызывают из кода подписок и организаций, а проверка старых отладочных проектов выполняется только при `isSaas` (`services/web/app/src/Features/Project/ProjectListController.mjs:234-236`).

#### Кто читает

| Код | Что делает |
| - | - |
| `Notifications.js:4-10` (`getUserNotifications`) | `GET /user/:user_id` (`app.ts:30`). Возвращает только те документы пользователя, у которых ещё есть `templateKey`. |
| `services/web/app/src/Features/Project/ProjectListController.mjs:367` | Загружает уведомления для панели проектов. |
| `services/web/app/src/Features/Notifications/NotificationsController.mjs` | `GET /notifications`, `DELETE /notifications/:notificationId` и `GET /user/notification/:notificationId` (`services/web/app/src/router.mjs:922-937`). |
| `services/web/modules/dropbox/app/src/DropboxHandler.mjs:128-131` | Наш модуль Dropbox: когда пользователь снова привязывает Dropbox, помечает `dropbox-unlinked` и `dropboxDuplicateProjectNames-<userId>` прочитанными. |

#### Индексы

| Имя | Ключи | Параметры | Миграция |
| - | - | - | - |
| `expires_1` | `{ expires: 1 }` | TTL, `expireAfterSeconds: 10` | `tools/migrations/20190912145014_create_notifications_indexes.mjs` |
| `key_1` | `{ key: 1 }` | | та же |
| `user_id_1` | `{ user_id: 1 }` | | та же |

#### Примечания

* Прочитанное уведомление не удаляется: пропадает только `templateKey`. Поскольку документ по-прежнему хранит ключ, последующий `addNotification` без `forceCreate` для того же ключа ничего не делает (`Notifications.js:21-24`).
* Маршруты `/key/:key` работают только по ключу, для всех пользователей (`Notifications.js:76-100`).
* Если у `web` нет `apis.notifications.url`, он не создаёт и не читает уведомления (`NotificationsHandler.mjs:17`, `:41`).


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