# Timetables Backend

## Purpose

`timetables` is a named, dated schedule (a campus/academic-year timetable with a draft/active/
archived status) that owns a set of `timetable_periods`. It is a generic-CRUD slice assembled
from the shared factories.

## Slice Files (by layer)

- Route: `src/routes/timetables.ts` — `createCrudRouter(controller, { permission: 'timetables' })`.
- Controller: `src/api/controllers/timetables.controller.ts` — `createCrudController(service, { csvFields })`.
- Service (BLL): `src/services/timetables.ts` — `createCrudService(DbApi, { notFoundCode: 'timetablesNotFound' })`.
- Repository (DAL): `src/db/api/timetables.ts` (`TimetablesDBApi`) — entity-specific
  `create`/`bulkImport`/`update`/`findBy`/`findAll`; `remove`/`deleteByIds`/`findAllAutocomplete`
  delegate to `db/api/shared/repository.ts`.
- Model: `src/db/models/timetables.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`),
  `db/utils.ts` (`Utils.uuid`/`Utils.ilike`), `shared/constants/database.ts`
  (`BULK_IMPORT_TIMESTAMP_STEP_MS`).

## API

The standard generic-CRUD surface (all under `/api/timetables`, JWT +
`${METHOD}_TIMETABLES` permission, all `200`) — see `backend-architecture.md` for the shared
9-endpoint 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`, `effective_from`, `effective_to`.

## Access Rules

- JWT required; the whole router is guarded by `checkCrudPermissions('timetables')`, deriving
  `READ_TIMETABLES` / `CREATE_TIMETABLES` / `UPDATE_TIMETABLES` / `DELETE_TIMETABLES` 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.
- `effective_from`, `effective_to` — DATE.
- `status` — ENUM `draft` | `active` | `archived`.
- `importHash` (STRING(255), unique), `academic_yearId`, `campusId`, `organizationId`,
  `createdById`, `updatedById`, timestamps (all UUID FKs nullable).

Associations: `belongsTo` organization, campus, academic_year (`academic_years`),
createdBy/updatedBy (users); `hasMany` `timetable_periods` as `timetable_periods_timetable`.
`findBy`/`GET /:id` eager-load `timetable_periods_timetable`, organization, campus, and
academic_year in a single `Promise.all`.

List filters (`TimetablesFilter`): `id`, `name` (iLike), `effective_fromRange`,
`effective_toRange`, `status`, `campus` (id or name, `|`-separated), `academic_year` (id or
name), `organization`, `createdAtRange`, plus a calendar overlap pair `calendarStart` +
`calendarEnd` (matches rows whose `effective_from` **or** `effective_to` falls between the two),
and `field`/`sort` ordering and `limit`/`page` pagination.

## Behavior / Notes

- `create`/`bulkImport`/`update` set associations via the Sequelize `set*` mixins (no file
  relations on this entity).
- `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: `TimetablesFilter` accepts an `active` flag the model has no column for; it is applied
  to `where.active` but, with no such column, is currently inert (kept for source accuracy).

## Tests

None yet.

## Related

- Generic-CRUD contract: `backend-architecture.md`; related slices: `timetable_periods`,
  `academic_years`, `campuses`, `permissions.md`.
