shoc-frontend-new/docs/ARCHITECTURE_PLAN.md
Arthur Bassi a0cf7b9ef0
Feat/vite typescript migration (#16)
* chore: add eslint, prettier, husky and commitlint tooling

* ci: add GitHub Actions workflow for lint and build

* build: migrate from CRA to Vite with TypeScript config

* docs: add architecture plan and design system documentation

* fix: scope ESLint to new components and hooks directories

* feat: add HTTP client, query cache and shared utilities

* feat: add theme system and global application styles

* feat: add shared UI, layout and domain badge components

* feat: add auth domain, provider and login page

* feat: add app shell, file-based routing and bootstrap

* feat: add protected layout and dashboard module

* feat: add accounts CRUD module

* feat: add assets CRUD module

* feat: add contacts CRUD module

* feat: add employees CRUD module

* feat: add locations CRUD module

* feat: add calendar events module

* feat: add follow-ups CRUD module

* feat: add PM schedules CRUD module

* feat: add work orders module with dispatch modals

* feat: add vendors CRUD and portal token panel

* feat: add vendor purchase orders module

* feat: add uplifts queue module

* feat: add settings for dropdowns and task templates

* feat: add vendor portal routes and signature capture

* test: add Vitest setup and Playwright login e2e spec

* chore: remove legacy CRA pages, Redux store and JS hooks

* chore: update gitignore and env example for Vite

* docs: translate pt-BR docs and Cursor rules to English

* fix(ci): fix login e2e session mock and prettier formatting

* fix(build): use mjs router script for Node 20 CI compatibility

* chore: remove migration scripts and unused generouted router

* fix(auth): restore JWT and align CRUD with backend routes

* fix(api): add no-content helpers and align paths with backend

* fix(accounts): align detail and mutation payloads with backend

* fix(contacts): resolve detail via GetContacts and map address DTOs

* fix(work-orders): align routes, delete body, and create payload

* fix(vendors): delete vendors via REST route

* fix(pm-schedules): handle empty save and delete responses

* fix(employees): add fallbacks for detail and dropdown calls

* chore(calendar): disable routes until backend exists

* chore(env): switch tracked env vars to Vite prefixes

* fix(api): align frontend contracts with backend review findings

Correct Work Order getById query param, asset site options via Location API,
Employee JobTitleId payload, and remove stale API paths.

* fix(employees,pm-schedules): align forms with backend API contracts

Align PM Schedule form and save payload with PMSchedule_DTO fields.
Bind employee Job Title select to jobTitleId for create/update payloads.
Add regression tests for both flows.

* fix(pm-schedules): gate edit/delete for Dev API contract

Production Dev API exposes only GetList and Save.

Hide unsupported edit/delete UI and block the edit route.

Add regression tests for disabled actions.

* docs(env): document VITE_API_URL must include /api suffix

* refactor(api): extract shared API prefix URL resolution

* feat(build): fail build on misconfigured absolute VITE_API_URL

* test(api): cover API URL contract and prefix resolution

* feat(auth): disable login submit until email and password are valid

* test(auth): align login tests with disabled submit behavior

* Feat/ab/menu-and-header (#17)

* chore(deps): add lucide-react for layout icon migration

* feat(auth): add getPrimaryUserRole helper for header display

* style(theme): add sidebar active tokens and nav group typography

* refactor(menu): migrate nav icons to lucide and trim menu groups

* feat(layout): redesign sidebar, topbar, and admin shell viewport

* chore(menu): hide Reports and Documents from sidebar

---------

Co-authored-by: Arthur Bassi <arthur.winiarski.ranger@outlook.com>

* ci: add frontend PR quality baseline (#18)

* chore(deps): add lucide-react for layout icon migration

* feat(auth): add getPrimaryUserRole helper for header display

* style(theme): add sidebar active tokens and nav group typography

* refactor(menu): migrate nav icons to lucide and trim menu groups

* feat(layout): redesign sidebar, topbar, and admin shell viewport

* chore(menu): hide Reports and Documents from sidebar

* ci: add PR quality baseline checks

* ci: avoid self-matching standards guard

* ci: split frontend quality gates

---------

Co-authored-by: Arthur Bassi <arthur.winiarski.ranger@outlook.com>

---------

Co-authored-by: Arthur Bassi <arthur.winiarski.ranger@outlook.com>
Co-authored-by: Alexandre Brandizzi <alex_brandizzi@hotmail.com>
2026-06-18 14:41:17 -03:00

4.7 KiB

Architecture Plan — SeaHaven (Selective Rebuild)

Aligned with IrisLoan.Admin · Vite SPA + React Router · no Next.js · Tailwind + MUI

Mirror document of the Cursor plan. Strategy: reuse knowledge, discard legacy code — do not normalize/refactor the current project.


Strategy in one sentence

Build api/ + domain/ + app/ from scratch; use pages/ only as endpoint and business rule reference; delete each legacy folder when the new feature is ready.


Matrix: Keep vs Discard

Keep (extract logic → new code)

Legacy Keep Destination
lib/api/services.js ASP.NET paths + response parsing api/api-paths.ts, api/handle-api-response.ts
pages/*/api.js Real endpoints api/api-paths.ts
constants/queryKeys.js Entities infra/query-key/query-key.ts
hooks/useDebounce.js, useModal.js Hooks hooks/*.ts
hooks/api/usePMSchedules.js RQ pattern Template domain/*/use-cases/
lib/queryClient.js Cache defaults lib/query/query-client.ts
App.js, Sidebar.js Routes and menu app/routes.tsx, config/menu.ts
pages/workorders/ (list) Business flow Reference for POC

Discard (delete without refactoring)

  • apiUtil.js, services/api.js, lib/api/client.js
  • tokenUtility.js, authService.js, Redux (app/store.js, slices)
  • usePaginatedList.js, entire pages/ folder (after replacement)
  • Site.Layout.js, setupProxy.js, site.css, per-feature CSS, Font Awesome
  • Forms *FormPage.js (rewrite with RHF + Zod)
  • SharedTable.js, ActionBar.js (recreate if adapting is costly)

Defer (later)

  • pages/vendor-portal/ → domain/vendor-portal/
  • pages/calendar/ → new FullCalendar wrapper

Feature priority

Full matrix (waves, dependencies, LOC, done criteria): FEATURE_PRIORITIZATION.md · TS config: src/config/feature-priorities.ts.

Wave Scope
0 POC auth → work-orders (list)
1 must-have work-orders (full), dashboard, settings/dropdowns
2 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

Stakeholder decision: auth + work-orders first; POC = auth + work-orders list (not pm-schedules).


Target structure

src/
├── api/
├── domain/<feature>/
├── infra/query-key/
├── lib/
├── components/ui/ + common/
├── app/
├── config/menu.ts
├── hooks/
├── providers/
└── main.tsx

Phases

Phase Goal
0 Complete foundation (Ky, routes, layout, AuthProvider, tooling) — Vite/TS/Tailwind ok
1 Ky + httpOnly auth cookies; delete legacy HTTP stacks
2 Rewrite must-have features; delete pages/<feature>/ per delivery
3 UI shell + RHF+Zod forms
4 Remove pages/, Redux, legacy CSS; Docker + CI + Vitest

Next steps

  1. Complete foundation (api/api.ts, routes.tsx, AuthProvider, layout shell)
  2. api/api-paths.ts (extract from lib/api/services.js)
  3. POC: domain/auth + login → delete pages/auth/
  4. POC: domain/work-orders (list) → delete list portion of pages/workorders/
  5. Cookie contract with backend

See full plan with diagrams in .cursor/plans/migração_arquitetura_irisloan_cf39e1a6.plan.md.