# Class Enrollments Backend

## Purpose

`class_enrollments` is the per-organization join between and `classes` — it records a
student's enrollment in a class with its own dates and status. It is a generic-CRUD slice
assembled from the shared factories; the backend is the source of truth for enrollment records.

## Slice Files (by layer)

- Route: `src/routes/class_enrollments.ts` — `createCrudRouter(controller, { permission: 'class_enrollments' })`.
- Controller: `src/api/controllers/class_enrollments.controller.ts` — `createCrudController(service, { csvFields })`.
- Service (BLL): `src/services/class_enrollments.ts` — `createCrudService(DbApi, { notFoundCode: 'class_enrollmentsNotFound' })`.
- Repository (DAL): `src/db/api/class_enrollments.ts` (`Class_enrollmentsDBApi`) — entity-specific
  `create`/`bulkImport`/`update`/`findBy`/`findAll`; `remove`/`deleteByIds`/`findAllAutocomplete`
  delegate to `db/api/shared/repository.ts`.
- Model: `src/db/models/class_enrollments.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/class_enrollments`, JWT +
`${METHOD}_CLASS_ENROLLMENTS` 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**), 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
  `status` (the field passed to `autocompleteByField`).
- `GET /:id` — returns the record with eager associations (see Data Contract).

`csvFields`: `id`, `enrolled_on`, `ended_on`.

## Access Rules

- JWT required; the whole router is guarded by `checkCrudPermissions('class_enrollments')`,
  deriving `READ_CLASS_ENROLLMENTS` / `CREATE_CLASS_ENROLLMENTS` / `UPDATE_CLASS_ENROLLMENTS` /
  `DELETE_CLASS_ENROLLMENTS` 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).

## Data Contract

Model columns (`paranoid`, soft-delete via `deletedAt`):

- `id` (UUID PK).
- `enrolled_on`, `ended_on` — DATE, nullable.
- `status` — ENUM `active` | `dropped` | `completed`.
- `importHash` (unique), `organizationId`, `classId`, `studentId`, `createdById`, `updatedById`,
  timestamps.

Associations: `belongsTo` organization, class (classes),
createdBy/updatedBy (users). This model declares no `hasMany`. `findBy`/`GET /:id` eager-load
organization and class in a single `Promise.all` (the class association is exposed on
the output as `class`).

List filters (`ClassEnrollmentsFilter`): `id`, `class` (id or name, `|`-separated), `student` (id
or `student_number`, `|`-separated), `enrolled_onRange`, `ended_onRange`, `status`,
`organization`, `createdAtRange`, plus `field`/`sort` ordering and `limit`/`page` pagination.

## Behavior / Notes

- `create`/`update` wire the organization, class and student relations via the `set*` association
  mixins; `bulkImport` does not set these relations.
- `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: `ClassEnrollmentsFilter` accepts an `active` flag the model has no column for; it is
  currently inert (kept for source accuracy).

## Tests

None yet.

## Related

- Generic-CRUD contract: `backend-architecture.md`; related slices: `classes`,
  `permissions.md`.