Update schemas.ts

Author: debater-coder

apps/client/src/services/sbhsApi/schemas.ts

@@ -300,3 +300,68 @@ export const daySchema = z.record(
     dayNumber: z.coerce.number().nullish(),
   })
 );
+
+const timetableSchema = z.object({
+  student: z.object({
+    surname: z.string(),
+    givenname: z.string(),
+    sex: z.string(), // "M"/"B" for male
+    DOB: z.string(), // date of birth. Unix timestamp
+    roll: z.coerce.number(), // index of roll class
+    lines: z.record(z.coerce.number()),
+    extraLines: z.record(z.coerce.number()),
+    BoSNumber: z.coerce.number(), // Board of Studies number. 0 if not available
+    studentId: z.string(), // Student ID number
+    year: z.string(), // student's [primary] year group
+    years: z.string().array(), // array of years the student is in
+  }),
+  days: z.record(
+    z.object({
+      dayname: z.string(), // name of the day
+      routine: z.string(), // routine (see timetable/daytimetable()
+      rollcall: z.object({
+        // roll call info for this day
+        title: z.string(), // name of roll class
+        teacher: z.string(), // teacher code for roll class
+        room: z.string(), // room for roll call
+      }),
+      periods: z.record(
+        z.object({
+          // corresponds to routine
+          title: z.string(), // short name for class
+          teacher: z.string(), // teacher code for class
+          room: z.string(), // room for class
+          year: z.string(), // year for class (Note [1])
+        })
+      ),
+    })
+  ),
+  subjects: z.record(
+    z.object({
+      title: "8 Maths 1", // title of the class
+      shortTitle: "Ma1", // corresponds to period.title
+      subject: "Mathematics", // full name of the subject
+      teacher: "DW", // teacher code for the class teacher
+      fullTeacher: "Mr R Dow", // full name of the teacher
+      year: "8", // year for the class (Note [1])
+    })
+  ),
+  extraSubjects: {
+    // collection of extra subjects
+    "1": {
+      // these subjects have no timetable classes
+      title: "Student Advis", // title of the class
+      shortTitle: "SA7", // corresponds to period.title
+      teacher: "DW", // teacher code for the class teacher
+      fullTeacher: "Mr R Dow", // full name of the teacher
+    },
+  },
+  rollcall: {
+    // roll class details
+    title: "08M", // title of the class
+    teacher: "DW", // teacher code for the teacher
+    fullTeacher: "Mr R Dow", // full name of the teacher
+    room: "   ", // roll class room
+  },
+  advisor: "Mr R Dowdell", // year adviser
+});