87 lines
4.2 KiB
Markdown
87 lines
4.2 KiB
Markdown
# Guardians Backend
|
|
|
|
## Purpose
|
|
|
|
`guardians` is the per-organization roster of student guardians/contacts, each optionally linked
|
|
to a single `student`. It is a generic-CRUD slice assembled from the shared factories; the
|
|
backend is the source of truth for guardian records.
|
|
|
|
## Slice Files (by layer)
|
|
|
|
- Route: `src/routes/guardians.ts` — `createCrudRouter(controller, { permission: 'guardians' })`.
|
|
- Controller: `src/api/controllers/guardians.controller.ts` — `createCrudController(service, { csvFields })`.
|
|
- Service (BLL): `src/services/guardians.ts` — `createCrudService(DbApi, { notFoundCode: 'guardiansNotFound' })`.
|
|
- Repository (DAL): `src/db/api/guardians.ts` (`GuardiansDBApi`) — entity-specific
|
|
`create`/`bulkImport`/`update`/`findBy`/`findAll`; `remove`/`deleteByIds`/`findAllAutocomplete`
|
|
delegate to `db/api/shared/repository.ts`.
|
|
- Model: `src/db/models/guardians.ts`.
|
|
- Shared used: CRUD factories (`services/shared/crud-service.ts`,
|
|
`api/controllers/shared/crud-controller.ts`, `api/http/crud-router.ts`), repository helpers
|
|
(`db/api/shared/repository.ts`), `shared/constants/pagination.ts` (`resolvePagination`),
|
|
`shared/constants/database.ts` (`BULK_IMPORT_TIMESTAMP_STEP_MS`), `db/utils.ts` (`Utils`).
|
|
|
|
## API
|
|
|
|
The standard generic-CRUD surface (all under `/api/guardians`, JWT + `${METHOD}_GUARDIANS`
|
|
permission, all `200`) — see `backend-architecture.md` for the shared contract:
|
|
|
|
- `POST /` — body `{ data }`, returns `true`.
|
|
- `POST /bulk-import` — multipart CSV file, returns `true`.
|
|
- `PUT /:id` — body `{ data, id }` (the service reads the id from the **body**, not the path
|
|
param), returns `true`.
|
|
- `DELETE /:id` — returns `true`.
|
|
- `POST /deleteByIds` — body `{ data: string[] }`, returns `true`.
|
|
- `GET /` — query filters, returns `{ rows, count }`; `?filetype=csv` streams a CSV of `csvFields`.
|
|
- `GET /count` — returns `{ rows: [], count }`.
|
|
- `GET /autocomplete` — `?query&limit&offset`, returns `[{ id, label }]` where `label` is
|
|
`full_name`.
|
|
- `GET /:id` — returns the record with eager associations (see Data Contract).
|
|
|
|
`csvFields`: `id`, `full_name`, `phone`, `email`, `address`.
|
|
|
|
## Access Rules
|
|
|
|
- JWT required; the whole router is guarded by `checkCrudPermissions('guardians')`, deriving
|
|
`READ_GUARDIANS` / `CREATE_GUARDIANS` / `UPDATE_GUARDIANS` / `DELETE_GUARDIANS` per HTTP method.
|
|
- Access is granted by role permission or per-user `custom_permissions` (see `permissions.md`).
|
|
|
|
## Tenant Scope
|
|
|
|
- `findAll` scopes `where.organizationId` to `currentUser.organizationId`; a `globalAccess`
|
|
role clears the org filter (sees all tenants).
|
|
- `create` assigns the organization from `currentUser.organizationId`; `update` only reassigns
|
|
organization for `globalAccess` users (otherwise it stays the caller's org), and only when
|
|
`data.organization` is provided.
|
|
|
|
## Data Contract
|
|
|
|
Model columns (`paranoid`, soft-delete via `deletedAt`):
|
|
|
|
- `id` (UUID PK), `full_name`, `phone`, `email`, `address` (TEXT, nullable).
|
|
- `relationship` — ENUM `mother` | `father` | `guardian` | `other`.
|
|
- `primary_contact` — BOOLEAN, `allowNull: false`, default `false`.
|
|
- `importHash` (unique), `organizationId`, `studentId`, `createdById`, `updatedById`, timestamps.
|
|
|
|
Associations: `belongsTo` organization, student, createdBy/updatedBy (users). `findBy`/`GET /:id`
|
|
eager-load organization and student in a single `Promise.all`.
|
|
|
|
List filters (`GuardiansFilter`): `id`, `full_name`, `phone`, `email`, `address`, `relationship`,
|
|
`primary_contact`, `student` (id or `student_number`, `|`-separated), `organization` (id list,
|
|
`|`-separated), `createdAtRange`, plus `field`/`sort` ordering and `limit`/`page` pagination.
|
|
|
|
## Behavior / Notes
|
|
|
|
- `bulkImport` offsets `createdAt` per row by `BULK_IMPORT_TIMESTAMP_STEP_MS` to preserve order.
|
|
- List pagination uses the shared `resolvePagination` defaults (page size 10, capped at 100).
|
|
- Note: `GuardiansFilter` accepts an `active` flag and `findAll` filters on an `active` column,
|
|
but the model has no `active` column; this filter is currently inert (kept for source accuracy).
|
|
|
|
## Tests
|
|
|
|
None yet.
|
|
|
|
## Related
|
|
|
|
- Generic-CRUD contract: `backend-architecture.md`; related slices: `students`, `organizations`,
|
|
`permissions.md`.
|