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