module-index.md 4.7 KB
Read this when choosing the analysis depth required before modifying a module.
Module Index
Tier 1 requires full context loading. Tier 2 is customized business logic. Tier 3 is standard framework usage. Tier 4 is thin/generated. Tier 5 is reference-only.
| Module | Path | Tier | Summary | Spec link |
|---|---|---|---|---|
| Bootstrap | index.php |
1 | Starts F3, loads encrypted runtime configuration, and boots plugins. | file structure |
| Plugin composition | src/OpenMind/System/ApplicationComposition.php, PluginStrategy.php |
1 | Discovers initializer classes by directory convention and maintains menu/route registration primitives. | add plugin rule |
| System services | src/OpenMind/System/System.php, OMUtils.php, ErrorHandlers.php |
1 | Database/cache initialization, config codec, framework error responses, and legacy utilities. | integrations |
| Identity and user management | src/OpenMind/System/User.php, Role.php, src/OpenMind/Api/AuthController.php, UserController.php, Controller.php |
1 | Session login, CSRF, numeric role assignments, account persistence, and user-mutation invariants. | identity spec |
| Role catalog | src/OpenMind/System/Role.php, src/OpenMind/Api/RoleController.php |
1 | Persistent role metadata and assignment-safe administrator CRUD; IDs are authorization keys. | role and inventory spec |
| Inventory demo persistence and API | src/OpenMind/System/InventoryItem.php, src/OpenMind/Api/InventoryController.php |
1 | Role-ID-2 persistent inventory demo CRUD with validation, safe DTOs, CSRF, and duplicate-SKU handling. | role and inventory spec |
| API registry | src/OpenMind/Api/Api.php |
2 | Maps all versioned JSON routes, including role catalog and inventory endpoints, to controllers. | API routes |
| Configuration administration | src/OpenMind/Api/AdminController.php, cfg/ |
1 | Reads, encodes, backs up, and replaces runtime configuration; local plaintext config is copied from the tracked template. | configuration spec |
| Navigation | src/OpenMind/Api/NavigationController.php, src/OpenMind/Admin/Admin.php, src/Modules/Blank/Blank.php |
2 | Builds the role-ID-filtered and ordered application menu, including Inventory Monitor. | API routes |
| Notifications | src/OpenMind/System/Notifications.php, src/OpenMind/Api/NotificationController.php |
2 | Persists, groups, polls, and deletes notification records. | API routes |
| Inventory Monitor demo plugin | src/Modules/Blank/Blank.php |
4 | Retained demo plugin initializer that publishes the ID-2 Inventory Monitor navigation entry without volatile role registration. | role and inventory spec |
| Database schema and migration | omlink.sql, scripts/migrate-role-catalog.php |
1 | MySQL role/inventory schema, constraints, seed records, and explicit legacy-role migration. | database conventions |
| React boot and routes | ui/app/src/main.jsx, App.jsx, routes.jsx |
2 | React/MUI setup, session bootstrap, guarded routes, and page selection. | frontend conventions |
| Frontend API client | ui/app/src/api/client.js |
1 | Same-origin URL resolution, cookies, JSON errors, and in-memory CSRF handling. | browser API integration |
| Admin React features | ui/app/src/features/admin/ |
2 | Configuration, user-management, and role-catalog UI. | API routes |
| Inventory demo React features | ui/app/src/features/demo/ |
2 | Persistent Inventory Monitor demo UI for role ID 2. |
role and inventory spec |
| Shell and notification UI | ui/app/src/features/shell/, features/notifications/ |
2 | Responsive dark drawer, route-aware selected navigation, contextual header, and 30-second notification polling. | frontend conventions |
| Home and auth pages | ui/app/src/features/auth/, features/home/ |
3 | Standard page-level views and login form. | frontend conventions |
| Visual configuration | ui/app/src/theme.js, styles.css |
2 | Customized MUI palette, navigation tokens, typography, shape, and Tailwind/global style entry points. | frontend conventions |
| Frontend build output | vite.config.js, assets/app/ |
4 | Vite configuration (including filtered "use client" warnings) and generated application assets. |
commands |
| Static assets | assets/images/ |
5 | Images referenced by the UI and legacy menus. | file structure |