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

# مجموعة Tokens

تحتوي `tokens` على رموز الاستخدام الواحد: السر الموجود في رابط يتيح لشخص ما تعيين كلمة مرور. كل مستند هو رمز واحد. لا يوجد نموذج Mongoose؛ يكتب web في المجموعة عبر `services/web/app/src/Features/Security/OneTimeTokenHandler.mjs` باستخدام برنامج التشغيل الأصلي.

#### الحقول

| الحقل | النوع | المعنى | المصدر |
| - | - | - | - |
| `_id` | ObjectId | معرّف المستند. | `OneTimeTokenHandler.mjs:40` |
| `use` | String | الغرض من الرمز، انظر [الاستخدامات](#uses) أدناه. يصفّي كل بحث على هذا الحقل. | `OneTimeTokenHandler.mjs:41` |
| `token` | String | السر في الرابط: 32 بايتاً عشوائياً على شكل 64 حرفاً سداسياً عشرياً، يُخزَّن كما هو. | `OneTimeTokenHandler.mjs:38,42` |
| `data` | Object | ما يمثّله الرمز، ويُعاد عند استخدامه. | `OneTimeTokenHandler.mjs:43` |
| `data.user_id` | String | معرّف المستخدم، يكتبه كل مستدعٍ كسلسلة نصية. | `services/web/app/src/Features/PasswordReset/PasswordResetHandler.mjs:27`, `services/web/app/src/Features/User/UserRegistrationHandler.mjs:117`, `services/web/modules/admin-tools/app/src/AdminUserManager.mjs:79` |
| `data.email` | String | بريد المستخدم عند إنشاء الرمز. تبحث إعادة تعيين كلمة المرور عن المستخدم بهذا البريد الرئيسي (`PasswordResetHandler.mjs:66-70`). | مثل `data.user_id` |
| `createdAt` | Date | وقت الإنشاء. يحذف فهرس TTL الرمز بعد 90 يوماً. | `OneTimeTokenHandler.mjs:36,44` |
| `expiresAt` | Date | `createdAt` مضافاً إليه `expiresIn` ثانية: ساعة واحدة افتراضياً، وأسبوع لرابط التفعيل. تتجاهل عمليات البحث الرمز بعد هذا الوقت. | `OneTimeTokenHandler.mjs:35-37,45` |
| `peekCount` | Number | عدد مرات الاطلاع على الرمز من دون استخدامه. يضيف كل `peekValueFromToken` واحداً؛ وعند 4 (`MAX_PEEKS`) يتوقف الرمز عن العمل. | `OneTimeTokenHandler.mjs:8-31,107` |
| `usedAt` | Date | وقت استخدام الرمز أو إلغائه. تتجاهل عمليات البحث الرمز الذي يحمل هذا الحقل. | `OneTimeTokenHandler.mjs:51-104` |

#### الاستخدامات

| `use` | الميزة | مدة الصلاحية | الشيفرة |
| - | - | - | - |
| `password` | بريد إعادة تعيين كلمة المرور من صفحة "نسيت كلمة المرور" | ساعة واحدة | `PasswordResetHandler.mjs:14-42` |
| `password` | رابط التفعيل: حساب يُنشأ بكلمة مرور عشوائية، ثم رابط لتعيين كلمة مرور. يستخدمه التسجيل العام (`services/web/modules/login-register/app/src/RegisterController.mjs:65`)، وصفحة تسجيل المشرف في `user-activate` (`services/web/modules/user-activate/app/src/UserActivateController.mjs:27-30`)، والسكربت `create-user` (`services/web/modules/server-ce-scripts/scripts/create-user.mjs:21`) | أسبوع واحد | `UserRegistrationHandler.mjs:97-130` |
| `password` | رابط تفعيل أو إعادة تعيين كلمة مرور يُرسل من لوحة الإدارة (الوحدة `admin-tools`) | أسبوع (التفعيل)، ساعة (إعادة التعيين) | `AdminUserManager.mjs:76-103,196-206` |
| `email_confirmation` | رابط تأكيد البريد. يُقرأ فقط: لم يعد أي شيء في هذا المستودع ينشئ مثل هذه الرموز، لأن التأكيد يرسل الآن رمزاً من 6 أرقام (`services/web/app/src/Features/User/UserEmailsConfirmationHandler.mjs:15-35`) | | `UserEmailsConfirmationHandler.mjs:12,37-66` |

#### من يكتب فيها

| الشيفرة | ما تفعله |
| - | - |
| `OneTimeTokenHandler.mjs:34-49` (`getNewToken`) | تُدرج رمزاً. المستدعون: `PasswordResetHandler.mjs:28`، `UserRegistrationHandler.mjs:115-119`، `AdminUserManager.mjs:77-81`. |
| `OneTimeTokenHandler.mjs:8-32` (`peekValueFromToken`) | تعيد `data` لرمز صالح وتضيف واحداً إلى `peekCount`. تُستخدم عند فتح صفحة إعادة تعيين كلمة المرور (`services/web/app/src/Features/PasswordReset/PasswordResetController.mjs:195-208`)، ومرة أخرى عند تعيين كلمة المرور الجديدة (`PasswordResetHandler.mjs:94-96`)، وفي تأكيد البريد (`UserEmailsConfirmationHandler.mjs:38-41`). |
| `OneTimeTokenHandler.mjs:75-88` (`expireToken`) | تعيّن `usedAt` على رمز واحد: بعد تعيين كلمة مرور جديدة (`PasswordResetHandler.mjs:44-48,119`) أو تأكيد بريد (`UserEmailsConfirmationHandler.mjs:65`). |
| `OneTimeTokenHandler.mjs:90-104` (`expireAllTokensForUser`) | تعيّن `usedAt` على كل رموز `password` المفتوحة للمستخدم، عندما يغيّر المستخدم كلمة المرور في الإعدادات (`services/web/app/src/Features/User/UserController.mjs:146-149`) أو يعيّنها مشرف في لوحة الإدارة (`AdminUserManager.mjs:479-488`). |

#### من يقرأ منها

| الشيفرة | ما تفعله |
| - | - |
| `PasswordResetHandler.mjs:50-70,94-119` | تحوّل رمز إعادة التعيين أو التفعيل إلى المستخدم، ثم تعيّن كلمة المرور. صفحة التفعيل في `user-activate` تمرّر الرمز إلى هذا النموذج فقط. |
| `UserEmailsConfirmationHandler.mjs:37-66` | تؤكد بريداً من رمز `email_confirmation` الخاص بالمستخدم المسجّل دخوله. |
| `AdminUserManager.mjs:213-223` (module `admin-tools`) | تجد رمز التفعيل المفتوح للمستخدم لعرض رابط التفعيل مجدداً في لوحة الإدارة. تقرأ `db.tokens` مباشرة. |

#### الفهارس

| الاسم | المفاتيح | الخيارات | الترحيل |
| - | - | - | - |
| `token_1_use_1` | `{ token: 1, use: 1 }` | فريد | `20190912145031_create_tokens_indexes.mjs` |
| `createdAt_1` | `{ createdAt: 1 }` | TTL، `expireAfterSeconds: 7776000` (90 يوماً) | `20210407085118_token-expiry-with-ttl-index.mjs` |
| `data.user_id_1` | `{ "data.user_id": 1 }` | | `20231113173237_tokens_user_id_index.mjs` |

الترحيلات موجودة في `tools/migrations/`.

#### ملاحظات

* لا يُحذف الرمز المستخدم أو المنتهي فوراً: يبقى مع `usedAt` أو `expiresAt` منقضٍ حتى يزيله فهرس TTL بعد 90 يوماً من `createdAt`.
* لدى `OneTimeTokenHandler` أيضاً `getValueFromTokenAndExpire` (`OneTimeTokenHandler.mjs:51-73`)، لكن لا شيء يستدعيها.


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