How maelgangloff/scolengo-api works
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: index.ts Skolengo client · User.ts User and auth data · Lesson.ts Lessons and agenda · HomeworkAssignment.ts Homework assignments
Components 16
Client and identity
- Skolengo client
src/index.ts - User and auth data
src/models/Common/User.ts
Calendar and homework
- Lessons and agenda
src/models/Calendar/Lesson.ts - Homework assignments
src/models/Calendar/HomeworkAssignment.ts
Evaluations and reports
- Evaluations
src/models/Results/EvaluationDetail.ts - Evaluation services
src/models/Results/EvaluationService.ts - Periodic reports
src/models/School/Attachment.ts
Messaging
- Communications
src/models/Messaging/Communication.ts - Mail settings
src/models/Messaging/UsersMailSettings.ts
School information
- School records
src/models/School/School.ts - School announcements
src/models/School/SchoolInfo.ts - Attachments
src/models/School/Attachment.ts
Attendance records
- Absence files
src/models/SchoolLife/AbsenceFile.ts - Absence reasons
src/models/SchoolLife/AbsenceReason.ts
Other components
- Integrating application
- Skolengo API
Connections 17
- Integrating application → Skolengo client: calls methods
README.md - Integrating application → User and auth data: provides auth data
- Skolengo client → Skolengo API: requests data
src/index.ts - Skolengo client → School records: searches schools
src/index.ts - Skolengo client → User and auth data: fetches user info
src/index.ts - Skolengo client → School announcements: fetches announcements
src/index.ts - Skolengo client → Attachments: downloads files
README.md - Skolengo client → Lessons and agenda: fetches agenda
README.md - Skolengo client → Lessons and agenda: fetches lessons
src/index.ts - Skolengo client → Homework assignments: fetches and updates
src/index.ts - Skolengo client → Evaluations: fetches evaluations
src/index.ts - Skolengo client → Evaluation services: fetches evaluations
src/index.ts - Skolengo client → Periodic reports: fetches reports
src/index.ts - Skolengo client → Communications: reads and posts
src/index.ts - Skolengo client → Mail settings: fetches settings
src/index.ts - Skolengo client → Absence files: reads and updates
README.md - Skolengo client → Absence reasons: fetches reasons
src/index.ts