shoc-frontend-new/docs/FEATURE_PRIORITIZATION.md

160 lines
12 KiB
Markdown

# Matriz de Priorização de Features — SeaHaven
> Fonte de verdade para ordem de migração legado → `domain/` + `app/`.
> Config machine-readable: [`src/config/feature-priorities.ts`](../src/config/feature-priorities.ts).
---
## Decisões de stakeholders
| Decisão | Detalhe |
| ------------------- | -------------------------------------------------------------------------------------- |
| Prioridade absoluta | **`auth`** e **`work-orders`** |
| POC end-to-end | **`auth` + work-orders (list)** — validar Ky, React Query, layout shell e AuthProvider |
| Demais features | Ordem flexível, guiada por dependências técnicas (waves abaixo) |
| POC **não** inclui | `pm-schedules` (adiado para Wave 4) |
---
## Matriz completa
| Ordem | Feature | Tier | Wave | Pasta legado | Rotas | LOC ~ | Dependências |
| ----- | ------------------------- | ----------- | ---- | ----------------------------------- | ----------------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------- |
| 1 | auth | POC | 0 | `pages/auth/` | `/login` | 513 | — |
| 2 | work-orders (list) | POC | 0 | `pages/workorders/` (list) | `/workorders` | 4.3k\* | auth |
| 3 | work-orders (form + view) | must-have | 1 | `pages/workorders/` | `/workorders/new`, `/workorders/:id`, `/workorders/edit/:id` | 4.3k\* | auth, work-orders (list), settings/dropdowns, accounts, locations, employees |
| 4 | dashboard | must-have | 1 | `pages/Dashboard.js` | `/`, `/dashboard` | 253 | auth |
| 5 | settings/dropdowns | must-have | 1 | `pages/settings/` (DropdownOptions) | `/settings/dropdowns` | 866\* | auth |
| 6 | accounts | must-have | 2 | `pages/accounts/` | `/accounts`, `/accounts/new`, `/accounts/edit/:id` | 745 | auth |
| 7 | locations | must-have | 2 | `pages/locations/` | `/locations`, `/locations/new`, `/locations/edit/:id` | 1.1k | auth, accounts |
| 8 | employees | must-have | 2 | `pages/employees/` | `/employees`, `/employees/new`, `/employees/edit/:id` | 1.9k | auth |
| 9 | vendors | should-have | 3 | `pages/vendors/` | `/vendors`, `/vendors/new`, `/vendors/edit/:id` | 610 | auth, work-orders (full) |
| 10 | vendor-pos | should-have | 3 | `pages/vendor-pos/` | `/vendor-pos`, `/vendor-pos/:id` | 1k | auth, work-orders (full) |
| 11 | uplifts | should-have | 3 | `pages/uplifts/` | `/uplifts` | 317 | auth, work-orders (full) |
| 12 | follow-ups | should-have | 3 | `pages/followup/` | `/followups`, `/followups/new`, `/followups/edit/:id` | 1.3k | auth, employees, accounts, locations |
| 13 | contacts | should-have | 3 | `pages/contacts/` | `/contacts`, `/contacts/new`, `/contacts/edit/:id` | 1.1k | auth |
| 14 | settings/task-templates | should-have | 3 | `pages/settings/` (TaskTemplates) | `/settings/task-templates` | 866\* | auth, work-orders (full) |
| 15 | calendar | later | 4 | `pages/calendar/` | `/calendar`, `/calendar/new`, `/calendar/edit/:id` | 1.9k | auth |
| 16 | vendor-portal | later | 4 | `pages/vendor-portal/` | `/v/:token`, `/v/:token/dashboard`, `/v/:token/pos`, `/v/:token/dispatch/:id` | 1.4k | auth, vendors |
| 17 | pm-schedules | later | 4 | `pages/PmSchedule/` | `/pmschedules`, `/pmschedules/new`, `/pmschedules/edit/:id` | 1.1k | auth |
| 18 | assets | later | 4 | `pages/assets/` | `/assets`, `/assets/new`, `/assets/edit/:id` | 638 | auth, accounts |
| 19 | reports / documents | later | 4 | — (sem implementação) | `/reports`, `/documents` (menu apenas) | — | auth |
\* LOC da pasta inteira; escopo POC usa somente o submódulo de listagem.
### Complexidade legada (referência)
| Feature | Complexidade | Observação |
| ------------- | ------------ | ----------------------------------------------------------- |
| auth | Baixa | Substituir Redux/`tokenUtility` por AuthProvider + cookies |
| dashboard | Média | KPIs reais via `GET /Dashboard/Stats` |
| work-orders | **Alta** | View monolítica; dispatch, checklist, signoff |
| contacts | Alta | Form legado **stub** (save TODO) — reescrever com RHF + Zod |
| employees | Alta | Form grande |
| vendor-portal | Alta | Auth por token URL + assinatura |
| calendar | Alta | Wrapper FullCalendar |
| pm-schedules | Média | Bugs API legados (`PmSchedule/Create` vs `Save`) |
---
## Grafo de dependências
```mermaid
flowchart TD
subgraph wave0 [Wave0_POC]
auth[auth]
woList[work_orders_list]
end
subgraph wave1 [Wave1_MustHave]
woFull[work_orders_full]
dash[dashboard]
dropdowns[settings_dropdowns]
end
subgraph wave2 [Wave2_Dependencies]
accounts[accounts]
locations[locations]
employees[employees]
end
subgraph wave3 [Wave3_ShouldHave]
vendors[vendors]
vendorPos[vendor_pos]
uplifts[uplifts]
followups[follow_ups]
contacts[contacts]
settingsTpl[task_templates]
end
subgraph wave4 [Wave4_Later]
calendar[calendar]
vendorPortal[vendor_portal]
pmSched[pm_schedules]
assets[assets]
reports[reports_documents]
end
auth --> woList
woList --> woFull
dropdowns --> woFull
accounts --> woFull
locations --> woFull
employees --> woFull
woFull --> vendors
vendors --> vendorPortal
woFull --> vendorPos
woFull --> uplifts
```
### Waves (resumo)
| Wave | Tier | Features |
| ----- | ----------- | --------------------------------------------------------------------------- |
| **0** | POC | auth, work-orders (list) |
| **1** | must-have | work-orders (full), dashboard, settings/dropdowns |
| **2** | must-have | accounts, locations, employees |
| **3** | should-have | vendors, vendor-pos, uplifts, follow-ups, contacts, settings/task-templates |
| **4** | later | calendar, vendor-portal, pm-schedules, assets, reports/documents |
> `accounts` e `locations` podem avançar em paralelo à view de WO se a list POC usar dados já existentes no backend; a ordem acima é a sequência mínima para o form completo de WO.
---
## Gaps e cleanup do legado
| Item | Local | Ação na migração |
| ------------------------ | --------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| Dashboard duplicado | `pages/dashboard/` (protótipo mock) | **Não roteado** — ignorar; usar apenas `pages/Dashboard.js` como referência |
| Login órfão | `pages/user/api.js` | Deletar na Fase 1 (Ky + auth); duplica fluxo de `pages/auth/` |
| Menu fantasma | `Sidebar.js` → Reports `/reports`, Documents `/documents` | Sem rotas nem páginas — implementar do zero (Wave 4) ou remover do menu em `config/menu.ts` |
| Contacts form incompleto | `pages/contacts/form/` | Não portar stub; reescrever com RHF + Zod na Wave 3 |
| PM schedules API | `pages/PmSchedule/` | Documentar inconsistência Create vs Save; corrigir na reescrita |
---
## Critérios de "done" por feature
Uma feature está **done** quando todos os itens abaixo forem atendidos:
1. **`domain/<feature>/`** — schemas Zod, hooks/use-cases, tipos; sem imports de `pages/`, Redux, axios ou `apiUtil`
2. **`app/`** — views finas (list, form, view conforme escopo) registradas em `app/routes.tsx`
3. **`api/api-paths.ts`** — endpoints da feature centralizados; respostas via `handle-api-response.ts`
4. **`infra/query-key/query-key.ts`** — query keys da feature
5. **Rota protegida** — navegação via `config/menu.ts` (quando aplicável à wave)
6. **Delete legado** — pasta `pages/<feature>/` (ou arquivos equivalentes) removida após validação
7. **Sem regressão** — fluxo principal testado manualmente ou com Vitest (quando existir)
### Done por escopo especial
| Escopo | Critério adicional |
| ------------------------ | ---------------------------------------------------------------------------------- |
| **POC auth** | Login/logout com cookies httpOnly; `AuthProvider` substitui Redux + `tokenUtility` |
| **POC work-orders list** | Listagem paginada/filtrada com Ky + RQ; sem form/view nesta entrega |
| **work-orders full** | Form + view (dispatch, checklist, signoff) funcionais |
| **settings/dropdowns** | Dropdowns Problem/Trade/SubTrade disponíveis para WO form |
| **reports/documents** | Decisão explícita: implementar feature ou remover links do menu |
---
## Referências
- Plano de arquitetura: [`ARCHITECTURE_PLAN.md`](ARCHITECTURE_PLAN.md)
- Convenções IrisLoan: `.cursor/rules/seahaven-admin.mdc`
- Rotas legado: `src/App.js`
- Menu legado: `src/components/Sidebar.js`