# maelgangloff/scolengo-api architecture

> Architecture diagram of the GitHub repository maelgangloff/scolengo-api, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/maelgangloff/scolengo-api
- Repository: https://github.com/maelgangloff/scolengo-api

## Overview

scolengo-api is an unofficial TypeScript client for retrieving and updating a user’s Skolengo ENT data. The main workflow is for an application to provide school and OpenID token information, call the client’s domain methods, and receive deserialized data from Skolengo; some methods also update data or download attachments. The graph preserves the documented calendar, results, messaging, school-information, and absence capabilities. The API entry point is excerpted; several capability links rely on README method documentation, so unsampled implementation details are not inferred.

Main entry points: [`src/index.ts`](https://github.com/maelgangloff/scolengo-api/blob/master/src/index.ts) (Skolengo client), [`src/models/Common/User.ts`](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Common/User.ts) (User and auth data), [`src/models/Calendar/Lesson.ts`](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Calendar/Lesson.ts) (Lessons and agenda), [`src/models/Calendar/HomeworkAssignment.ts`](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Calendar/HomeworkAssignment.ts) (Homework assignments)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Client and identity"]
  node_client["Skolengo client<br/>[index.ts]"]
  node_identity["User and auth data<br/>[User.ts]"]
end

subgraph group_calendar["Calendar and homework"]
  node_calendar["Lessons and agenda<br/>[Lesson.ts]"]
  node_homework["Homework assignments"]
end

subgraph group_results["Evaluations and reports"]
  node_evaluations["Evaluations"]
  node_evaluationservice["Evaluation services"]
  node_reports["Periodic reports<br/>[Attachment.ts]"]
end

subgraph group_messaging["Messaging"]
  node_messaging["Communications<br/>[Communication.ts]"]
  node_mailsettings["Mail settings"]
end

subgraph group_school["School information"]
  node_school["School records<br/>[School.ts]"]
  node_schoolinfo["School announcements<br/>[SchoolInfo.ts]"]
  node_attachments["Attachments<br/>[Attachment.ts]"]
end

subgraph group_attendance["Attendance records"]
  node_absences["Absence files<br/>[AbsenceFile.ts]"]
  node_absencereasons["Absence reasons<br/>[AbsenceReason.ts]"]
end

node_application(("Integrating application"))
node_skolengo{{"Skolengo API"}}

node_application -->|"calls methods"| node_client
node_application -.->|"provides auth data"| node_identity
node_client -->|"requests data"| node_skolengo
node_client -->|"searches schools"| node_school
node_client -->|"fetches user info"| node_identity
node_client -->|"fetches announcements"| node_schoolinfo
node_client -->|"downloads files"| node_attachments
node_client -->|"fetches agenda"| node_calendar
node_client -->|"fetches lessons"| node_calendar
node_client -->|"fetches and updates"| node_homework
node_client -->|"fetches evaluations"| node_evaluations
node_client -->|"fetches evaluations"| node_evaluationservice
node_client -->|"fetches reports"| node_reports
node_client -->|"reads and posts"| node_messaging
node_client -->|"fetches settings"| node_mailsettings
node_client -->|"reads and updates"| node_absences
node_client -->|"fetches reasons"| node_absencereasons

click node_client "https://github.com/maelgangloff/scolengo-api/blob/master/src/index.ts"
click node_identity "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Common/User.ts"
click node_school "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/School/School.ts"
click node_schoolinfo "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/School/SchoolInfo.ts"
click node_attachments "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/School/Attachment.ts"
click node_calendar "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Calendar/Lesson.ts"
click node_homework "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Calendar/HomeworkAssignment.ts"
click node_evaluations "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Results/EvaluationDetail.ts"
click node_evaluationservice "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Results/EvaluationService.ts"
click node_reports "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/School/Attachment.ts"
click node_messaging "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Messaging/Communication.ts"
click node_mailsettings "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Messaging/UsersMailSettings.ts"
click node_absences "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/SchoolLife/AbsenceFile.ts"
click node_absencereasons "https://github.com/maelgangloff/scolengo-api/blob/master/src/models/SchoolLife/AbsenceReason.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_client,node_identity toneBlue
class node_calendar,node_homework toneAmber
class node_evaluations,node_evaluationservice,node_reports,node_skolengo toneMint
class node_messaging,node_mailsettings toneRose
class node_school,node_schoolinfo,node_attachments,node_application toneIndigo
class node_absences,node_absencereasons toneTeal
```

## Components

### Client and identity

- [Skolengo client](https://github.com/maelgangloff/scolengo-api/blob/master/src/index.ts): `src/index.ts`
- [User and auth data](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Common/User.ts): `src/models/Common/User.ts`

### Calendar and homework

- [Lessons and agenda](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Calendar/Lesson.ts): `src/models/Calendar/Lesson.ts`
- [Homework assignments](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Calendar/HomeworkAssignment.ts): `src/models/Calendar/HomeworkAssignment.ts`

### Evaluations and reports

- [Evaluations](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Results/EvaluationDetail.ts): `src/models/Results/EvaluationDetail.ts`
- [Evaluation services](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Results/EvaluationService.ts): `src/models/Results/EvaluationService.ts`
- [Periodic reports](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/School/Attachment.ts): `src/models/School/Attachment.ts`

### Messaging

- [Communications](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Messaging/Communication.ts): `src/models/Messaging/Communication.ts`
- [Mail settings](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/Messaging/UsersMailSettings.ts): `src/models/Messaging/UsersMailSettings.ts`

### School information

- [School records](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/School/School.ts): `src/models/School/School.ts`
- [School announcements](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/School/SchoolInfo.ts): `src/models/School/SchoolInfo.ts`
- [Attachments](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/School/Attachment.ts): `src/models/School/Attachment.ts`

### Attendance records

- [Absence files](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/SchoolLife/AbsenceFile.ts): `src/models/SchoolLife/AbsenceFile.ts`
- [Absence reasons](https://github.com/maelgangloff/scolengo-api/blob/master/src/models/SchoolLife/AbsenceReason.ts): `src/models/SchoolLife/AbsenceReason.ts`

### Other components

- **Integrating application**
- **Skolengo API**

## Connections

- Integrating application → Skolengo client: calls methods (evidence: `README.md`)
- Integrating application → User and auth data: provides auth data
- Skolengo client → Skolengo API: requests data (evidence: `src/index.ts`)
- Skolengo client → School records: searches schools (evidence: `src/index.ts`)
- Skolengo client → User and auth data: fetches user info (evidence: `src/index.ts`)
- Skolengo client → School announcements: fetches announcements (evidence: `src/index.ts`)
- Skolengo client → Attachments: downloads files (evidence: `README.md`)
- Skolengo client → Lessons and agenda: fetches agenda (evidence: `README.md`)
- Skolengo client → Lessons and agenda: fetches lessons (evidence: `src/index.ts`)
- Skolengo client → Homework assignments: fetches and updates (evidence: `src/index.ts`)
- Skolengo client → Evaluations: fetches evaluations (evidence: `src/index.ts`)
- Skolengo client → Evaluation services: fetches evaluations (evidence: `src/index.ts`)
- Skolengo client → Periodic reports: fetches reports (evidence: `src/index.ts`)
- Skolengo client → Communications: reads and posts (evidence: `src/index.ts`)
- Skolengo client → Mail settings: fetches settings (evidence: `src/index.ts`)
- Skolengo client → Absence files: reads and updates (evidence: `README.md`)
- Skolengo client → Absence reasons: fetches reasons (evidence: `src/index.ts`)
