Documentation coverage
What this site documents, what it omits, and how topics map to ./ApiTables/
This site is the frontend reference for ApiTables in bolesa-app-ui. It does not replace backend API specs, OpenAPI docs, or team runbooks for control-table configuration.
In scope (frontend)
| Area | Docs | Source in bolesa-app-ui |
|---|---|---|
| Page integration | Getting started, Entry components | ReactApiTable, useTableStructure |
| Lifecycle & APIs (client) | Architecture, Data flow | Controller, fetcher, axiosTable |
| Redux | Providers, Redux store | table-providers/ |
| Action HTTP layer | useUtilsProvider | useUtilsProvider.tsx |
| Columns & cells | Columns, Column types | ColumnCellTypes, formatTableColumns |
| Filters | Filters | TableFilters, AppliedFilters |
| Sorting | Sorting | TableSorting, TableBody |
| Row actions | Row actions | RowActionsElements, TableRowActions |
| Bulk actions | Bulk actions | TableBulkActions, ActionsOfSelection |
| Custom modals | Custom controls, Wired controls | ApiTablesModals, custom-controls/ |
| Global app bridge | External state | getExternalState, outScopeTableRefresher |
| UI map | UI layout, Core components | core/, general-components/ |
| Structure contract | Table structure | Structure GET + controller init |
| Errors & toasts | Errors and feedback | errorHandling.ts |
Out of scope (document elsewhere)
| Topic | Why |
|---|---|
| Backend control-table definitions | Owned by API / Laravel (or equivalent); frontend only consumes JSON |
| Database schema & permissions | Not in ./ApiTables/ |
| Full list of production table names | Feature pages under app/[locale]/ choose their own load-table/... paths |
| WMS / other apps’ ApiTables forks | This repo targets bolesa-app-ui; other codebases may differ |
| Automated tests for ApiTables | Not part of this docs package |
Package inventory
Every file under ./ApiTables/ in bolesa-app-ui is listed in Package map. When you add a file there, update that page and the relevant topic doc.
Before you publish
- Scope — Home page and index state frontend-only authorship; backend credit stays with the wider team.
- Custom controls — Wired controls matches
ApiTablesModals.tsxin bolesa-app-ui (re-check after backend adds newcustom_controlURLs). - Dead imports — Documented unused modal imports; remove or wire before telling consumers they exist.
- Paths — Docs use
./ApiTables/; app imports use@/app/ApiTables/.... - Theme — Site defaults to dark (
app/layout.tsx); content is theme-agnostic. - Search — Run the docs site locally and hit
⌘Kon long pages (filters, column types). - Build —
pnpm types:checkandpnpm buildshould pass with no MDX errors.