87 lines
4.1 KiB
Markdown
87 lines
4.1 KiB
Markdown
# Academic Years Backend
|
|
|
|
## Purpose
|
|
|
|
`academic_years` is the per-organization roster of academic year periods. It is a generic-CRUD
|
|
slice assembled from the shared factories; the backend is the source of truth for these records.
|
|
|
|
## Slice Files (by layer)
|
|
|
|
- Route: `src/routes/academic_years.ts` — `createCrudRouter(controller, { permission: 'academic_years' })`.
|
|
- Controller: `src/api/controllers/academic_years.controller.ts` — `createCrudController(service, { csvFields })`.
|
|
- Service (BLL): `src/services/academic_years.ts` — `createCrudService(DbApi, { notFoundCode: 'academic_yearsNotFound' })`.
|
|
- Repository (DAL): `src/db/api/academic_years.ts` (`Academic_yearsDBApi`) — entity-specific
|
|
`create`/`bulkImport`/`update`/`findBy`/`findAll`; `remove`/`deleteByIds`/`findAllAutocomplete`
|
|
delegate to `db/api/shared/repository.ts`.
|
|
- Model: `src/db/models/academic_years.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`).
|
|
|
|
## API
|
|
|
|
The standard generic-CRUD surface (all under `/api/academic_years`, JWT + `${METHOD}_ACADEMIC_YEARS`
|
|
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 `name`.
|
|
- `GET /:id` — returns the record with eager associations (see Data Contract).
|
|
|
|
`csvFields`: `id`, `name`, `start_date`, `end_date`.
|
|
|
|
## Access Rules
|
|
|
|
- JWT required; the whole router is guarded by `checkCrudPermissions('academic_years')`, deriving
|
|
`READ_ACADEMIC_YEARS` / `CREATE_ACADEMIC_YEARS` / `UPDATE_ACADEMIC_YEARS` /
|
|
`DELETE_ACADEMIC_YEARS` 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), `name` (TEXT, nullable).
|
|
- `start_date`, `end_date` — DATE, nullable.
|
|
- `current` — BOOLEAN, `allowNull: false`, default `false`.
|
|
- `importHash` (unique), `organizationId`, `createdById`, `updatedById`, timestamps.
|
|
|
|
Associations: `belongsTo` organization, createdBy/updatedBy (users); `hasMany`
|
|
`classes_academic_year` (classes), `timetables_academic_year` (timetables),
|
|
`fee_plans_academic_year` (fee_plans). `findBy`/`GET /:id` eager-load
|
|
`classes_academic_year`, `timetables_academic_year`, `fee_plans_academic_year`, and
|
|
`organization` in a single `Promise.all`.
|
|
|
|
List filters (`AcademicYearsFilter`): `id`, `name`, `calendarStart`+`calendarEnd` (matches rows
|
|
whose `start_date` or `end_date` falls between the two), `start_dateRange`, `end_dateRange`,
|
|
`active`, `current`, `organization` (`|`-separated ids), `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: `AcademicYearsFilter` 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`, `timetables`,
|
|
`fee_plans`, `organizations`, `permissions.md`.
|