065c053c16
Introduces modules/hospitality with 54 routes, BFF proxy, capability-gated nav, CRUD factory, and architecture validation docs. Co-authored-by: Cursor <cursoragent@cursor.com>
66 lines
2.6 KiB
Markdown
66 lines
2.6 KiB
Markdown
# Hospitality Component Map
|
|
|
|
**Module root:** `frontend/modules/hospitality/`
|
|
|
|
## Shell & navigation
|
|
|
|
| Component | Path | Role |
|
|
|-----------|------|------|
|
|
| `HospitalityPortalShell` | `components/HospitalityPortalShell.tsx` | Sidebar, mobile menu, theme toggle |
|
|
| `HospitalityRootLayout` | `components/createPortalLayout.tsx` | Auth + tenant gate; hub exception |
|
|
| `HospitalityBreadcrumbs` | `components/HospitalityBreadcrumbs.tsx` | Page breadcrumb trail |
|
|
| `HospitalityBundleGate` | `components/HospitalityBundleGate.tsx` | Feature/bundle visibility |
|
|
|
|
## Data pages
|
|
|
|
| Component | Path | Role |
|
|
|-----------|------|------|
|
|
| `createHospitalityListPage` | `components/HospitalityListCrudPage.tsx` | Factory for list+CRUD pages |
|
|
| `HospitalityTablePage` | `design-system/HospitalityTablePage.tsx` | Search + table + header |
|
|
| `HospitalityStatusChip` | `design-system/HospitalityStatusChip.tsx` | Lifecycle status badge |
|
|
|
|
## Pages (features)
|
|
|
|
| Feature file | Route | Primary API |
|
|
|--------------|-------|-------------|
|
|
| `dashboard.tsx` | `/hospitality` | venues, reservations, posTickets, kitchenTickets |
|
|
| `hub.tsx` | `/hospitality/hub` | — |
|
|
| `venues.tsx` | `/hospitality/branches` | `venues` |
|
|
| `branches.tsx` | `/hospitality/branches/list` | `branches` |
|
|
| `diningAreas.tsx` | `/hospitality/dining-areas` | `diningAreas` |
|
|
| `tables.tsx` | `/hospitality/tables` | `tables` |
|
|
| `menus.tsx` | `/hospitality/menu` | `menus` |
|
|
| `reservations.tsx` | `/hospitality/reservations` | `reservations` |
|
|
| `kitchenTickets.tsx` | `/hospitality/kitchen/display` | `kitchenTickets` |
|
|
| `posTickets.tsx` | `/hospitality/pos/lite` | `posTickets` |
|
|
| `analyticsSnapshots.tsx` | `/hospitality/analytics` | `analyticsSnapshots` |
|
|
| `tenantBundles.tsx` | `/hospitality/bundles` | `tenantBundles` |
|
|
| `health.tsx` | `/hospitality/health` | `health()` |
|
|
| `capabilities.tsx` | `/hospitality/capabilities` | `capabilities()` |
|
|
|
|
*(54 feature modules total — see routing map.)*
|
|
|
|
## Hooks
|
|
|
|
| Hook | Path |
|
|
|------|------|
|
|
| `useHospitalityCapabilities` | `hooks/useHospitalityCapabilities.ts` |
|
|
| `useHospitalityHealth` | `hooks/useHospitalityCapabilities.ts` |
|
|
| `useHospitalityLookups` | `hooks/useHospitalityCapabilities.ts` |
|
|
|
|
## Services
|
|
|
|
| Service | Path |
|
|
|---------|------|
|
|
| `hospitalityApi` | `services/hospitality-api.ts` |
|
|
| BFF proxy | `app/api/hospitality/[...path]/route.ts` |
|
|
|
|
## Shared platform (external)
|
|
|
|
| Import | Source |
|
|
|--------|--------|
|
|
| `@/components/ds` | Design system |
|
|
| `@/hooks/useTenantId` | Tenant context |
|
|
| `@/hooks/useMe` | Auth session |
|
|
| `@/components/AuthGuard` | Route protection |
|