mirror of
https://git.meshkee.com/Meshkee/backend.git
synced 2026-08-11 22:30:59 +04:30
Add passwordless OTP login and SMS password reset.
Expose login-otp and reset-password so dashboards can finish forgot-password and one-time SMS sign-in, and sync website API docs. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
co-authored by
Cursor
parent
f4295e780c
commit
08f901306c
+10
-4
@@ -1,7 +1,7 @@
|
||||
# Meshkee CMS API — Project Context
|
||||
|
||||
> Living reference for developers and AI assistants working on this codebase.
|
||||
> Last updated: August 4, 2026
|
||||
> Last updated: August 5, 2026
|
||||
|
||||
## What This Project Is
|
||||
|
||||
@@ -238,9 +238,11 @@ All routes are prefixed with `/api/v1`.
|
||||
|--------|------|-------------|
|
||||
| POST | `/auth/register` | Customer registration by domain |
|
||||
| POST | `/auth/login` | Cell + password |
|
||||
| POST | `/auth/login-otp` | Passwordless login with SMS OTP |
|
||||
| POST | `/auth/reset-password` | Reset password with SMS OTP |
|
||||
| POST | `/auth/refresh` | Refresh token |
|
||||
| POST | `/auth/send-otp` | Send OTP (Redis-backed) |
|
||||
| POST | `/auth/verify-otp` | Verify OTP |
|
||||
| POST | `/auth/verify-otp` | Verify OTP (marks cell verified; no tokens) |
|
||||
| GET | `/tenants/:host` | Resolve business from domain |
|
||||
| GET | `/tenants/:host/store-specials` | Active store specials |
|
||||
| GET | `/tenants/:host/website/category-groups` | Homepage category rows |
|
||||
@@ -361,6 +363,10 @@ Each resource typically has: `read`, `create`, `update`, `delete` (+ `publish` f
|
||||
|
||||
- Registration resolves tenant by `domain` → creates/links user → assigns `customer` role
|
||||
- OTP stored in Redis (`otp:{cellNumber}`), 5-min TTL; disabled when `SMS_ENABLED=false`
|
||||
- `POST /auth/send-otp` → SMS code; `POST /auth/verify-otp` marks `cellVerifiedAt` (no tokens)
|
||||
- `POST /auth/login-otp` → passwordless login (consumes OTP, verifies cell, returns tokens)
|
||||
- `POST /auth/reset-password` → forgot password (OTP + `newPassword`, verifies cell)
|
||||
- Password login (`POST /auth/login`) rejects unverified cells when SMS is enabled
|
||||
- JWT payload: `sub`, `cellNumber`, `roles`, `dashboard`, `type`
|
||||
- SMS provider: Gama (`sms.igama.ir`) SendQuick via service shortcode (`SMS_GAMA_*`)
|
||||
- Partner gateway (external sites like Balout): `POST /api/v1/public/sms/send` with `X-Api-Key` + body `{ domain, to, message }`; partners configured in `SMS_PARTNERS` (`domain:apiKey` pairs). Rate limits: 30/partner/min and 5/destination/min. Not part of storefront website-api docs.
|
||||
@@ -552,7 +558,7 @@ See `.env.example` for the full list. Key groups:
|
||||
|
||||
### Implemented
|
||||
|
||||
- Multi-tenant auth (register, login, OTP, profile)
|
||||
- Multi-tenant auth (register, login, passwordless OTP login, reset password via SMS, profile)
|
||||
- Super admin: users, businesses, domains, system business categories
|
||||
- Super admin: selective migrate-from-old + purge-data (portfolio categories + portfolios; oversized images resized to max 1280×1280; purge removes portfolios + images)
|
||||
- Business team management
|
||||
@@ -566,6 +572,7 @@ See `.env.example` for the full list. Key groups:
|
||||
- Category variations & technical forms
|
||||
- Tenant resolution by domain
|
||||
- RBAC with granular permissions
|
||||
- Auth SMS OTP via Gama SendQuick (`send-otp`, `verify-otp`, `login-otp`, `reset-password`)
|
||||
- Partner SMS gateway (`POST /public/sms/send`) + Gama SendQuick integration
|
||||
|
||||
### Planned / partial
|
||||
@@ -575,7 +582,6 @@ See `.env.example` for the full list. Key groups:
|
||||
| Blogs | Yes | Yes | No | No model |
|
||||
| Portfolios | Yes | Yes | Partial (migrate-from-old) | Yes |
|
||||
| Customer dashboard | Partial | No | Register only | Yes |
|
||||
| SMS provider | — | — | Stub | — |
|
||||
| Store checkout (cart, orders) | Yes | Yes | Yes | Yes |
|
||||
| Customer favorites | — | `favorites.*` seeded | No | No |
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ You are building a **Meshkee business website (storefront)**. You must use the M
|
||||
1. `GET /tenants/{domain}` → branding + `businessId`
|
||||
2. Homepage: business-info, sliders, category-groups, brand-groups, store-specials
|
||||
3. Catalog: categories, products, store-items
|
||||
4. Auth: register/login → store tokens
|
||||
4. Auth: register/login → store tokens. Optional: `POST /auth/send-otp` then `POST /auth/login-otp` (passwordless) or `POST /auth/reset-password` (forgot password). `POST /auth/verify-otp` only marks the cell verified (no tokens).
|
||||
5. Cart checkout with `addressId` or inline `shippingAddress` + `payment`
|
||||
|
||||
If OpenAPI and this brief conflict, **OpenAPI wins**.
|
||||
|
||||
@@ -200,6 +200,55 @@
|
||||
"url": "{{baseUrl}}/auth/login"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Login with OTP",
|
||||
"event": [
|
||||
{
|
||||
"listen": "test",
|
||||
"script": {
|
||||
"exec": [
|
||||
"if (pm.response.code === 200) {",
|
||||
" const json = pm.response.json();",
|
||||
" pm.collectionVariables.set('accessToken', json.accessToken);",
|
||||
" pm.collectionVariables.set('refreshToken', json.refreshToken);",
|
||||
"}"
|
||||
],
|
||||
"type": "text/javascript"
|
||||
}
|
||||
}
|
||||
],
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"cellNumber\": \"+98XXXXXXXXXX\",\n \"code\": \"123456\"\n}"
|
||||
},
|
||||
"url": "{{baseUrl}}/auth/login-otp"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Reset password (SMS OTP)",
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"header": [
|
||||
{
|
||||
"key": "Content-Type",
|
||||
"value": "application/json"
|
||||
}
|
||||
],
|
||||
"body": {
|
||||
"mode": "raw",
|
||||
"raw": "{\n \"cellNumber\": \"+98XXXXXXXXXX\",\n \"code\": \"123456\",\n \"newPassword\": \"newpassword123\"\n}"
|
||||
},
|
||||
"url": "{{baseUrl}}/auth/reset-password"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Me (current user)",
|
||||
"request": {
|
||||
|
||||
@@ -527,6 +527,51 @@
|
||||
"responses": { "200": { "description": "{ user, accessToken, refreshToken }" } }
|
||||
}
|
||||
},
|
||||
"/auth/login-otp": {
|
||||
"post": {
|
||||
"tags": ["Auth"],
|
||||
"summary": "Passwordless login with SMS OTP",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": ["cellNumber", "code"],
|
||||
"properties": {
|
||||
"cellNumber": { "type": "string" },
|
||||
"code": { "type": "string", "minLength": 6, "maxLength": 6 }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": { "200": { "description": "{ user, accessToken, refreshToken }" } }
|
||||
}
|
||||
},
|
||||
"/auth/reset-password": {
|
||||
"post": {
|
||||
"tags": ["Auth"],
|
||||
"summary": "Reset password with SMS OTP",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": ["cellNumber", "code", "newPassword"],
|
||||
"properties": {
|
||||
"cellNumber": { "type": "string" },
|
||||
"code": { "type": "string", "minLength": 6, "maxLength": 6 },
|
||||
"newPassword": { "type": "string", "minLength": 8 }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": { "200": { "description": "{ message }" } }
|
||||
}
|
||||
},
|
||||
"/auth/refresh": {
|
||||
"post": {
|
||||
"tags": ["Auth"],
|
||||
|
||||
Reference in New Issue
Block a user