feat: add signatures parsing

Author: Vexcited

src/biome/index.ts

@@ -6,7 +6,7 @@ import { type CAS, OAuth2 } from "~cas";
 export * from "./models";
 
 export class Biome {
-  public static readonly oauth2: OAuth2 = new OAuth2("biome-prod", "https://biome.unilim.fr/authentication/callback", ["openid", "profile", "email"]);
+  public static readonly oauth2 = new OAuth2("biome-prod", "https://biome.unilim.fr/authentication/callback", ["openid", "profile", "email"]);
   private static readonly HOST = "https://apis.unilim.fr";
 
   public get roles(): Array<string> {

src/iut/signatures/index.ts

@@ -1,12 +1,18 @@
+import type { Cheerio } from "cheerio";
+import type { AnyNode } from "domhandler";
 import type { HttpResponse } from "schwi";
+import type { Module, ReportCard, Semester, TeachingUnit } from "./models";
+import { load as cheerio } from "cheerio";
 import { HttpRequest, HttpRequestRedirection, send } from "schwi";
 import { CAS, OAuth2 } from "~cas";
 
+export * from "./models";
+
 export class Signatures {
   public static readonly COOKIE = "session";
 
   public static readonly HOST = "https://signatures.unilim.fr";
-  public static readonly oauth2: OAuth2 = new OAuth2("signatures", "https://signatures.unilim.fr/callback", ["openid", "profile"]);
+  public static readonly oauth2 = new OAuth2("signatures", "https://signatures.unilim.fr/callback", ["openid", "profile"]);
 
   public constructor(
     public readonly session: string
@@ -59,4 +65,90 @@ export class Signatures {
 
     return new Signatures(session);
   }
+
+  public static parse(html: string): ReportCard {
+    const text = <T extends AnyNode>(node: Cheerio<T>): string =>
+      node.text().trim();
+
+    const document = cheerio(html);
+    const semesters: Array<Semester> = [];
+
+    for (const button of document("button[data-bs-target*=semestre-]")) {
+      const table = document(`.tab-pane[aria-labelledby="${button.attribs.id}"] tbody`);
+
+      const units: Array<TeachingUnit> = [];
+      let unit: TeachingUnit | undefined;
+      let module: Module | undefined;
+
+      for (const tr of table.find("tr")) {
+        const level = parseInt(tr.attribs.class.replace("level-", ""));
+
+        const col1 = document(tr).find("td").first();
+        const col2 = col1.next();
+        const col3 = col2.next();
+        const col4 = col3.next();
+        const col5 = col4.next();
+        const col6 = col5.next();
+
+        const name = text(col2);
+        const coefficient = Number(text(col4));
+        const average = text(col5) ? Number(text(col5)) : null;
+
+        switch (level) {
+          case 1: {
+            unit = {
+              average,
+              code: text(col1),
+              coefficient,
+              modules: [],
+              name
+            };
+
+            units.push(unit);
+            break;
+          }
+
+          case 2: {
+            if (!unit) break;
+
+            module = {
+              average,
+              code: text(col1),
+              coefficient,
+              exams: [],
+              name
+            };
+
+            unit.modules.push(module);
+            break;
+          }
+
+          case 3: {
+            if (!module) break;
+
+            const globalAverage = text(col6).replace(/[()]/g, "");
+            const date = text(col1); // DD/MM/YYYY, empty string if none.
+
+            module.exams.push({
+              average,
+              coefficient,
+              date: date ? new Date(date.split("/").reverse().join("-")) : null,
+              globalAverage: globalAverage ? Number(globalAverage) : null,
+              name
+            });
+          }
+        }
+      }
+    }
+
+    const [fullName, promotion] = document(".list-group-item").map((_, node) => {
+      return text(document(node.lastChild!));
+    }).toArray();
+
+    return {
+      fullName,
+      promotion,
+      semesters
+    };
+  }
 }

src/iut/signatures/models/Exam.ts

@@ -0,0 +1,7 @@
+export interface Exam {
+  average: null | number;
+  coefficient: number;
+  date: Date | null;
+  globalAverage: null | number;
+  name: string;
+}

src/iut/signatures/models/Module.ts

@@ -0,0 +1,9 @@
+import type { Exam } from "./Exam";
+
+export interface Module {
+  average: null | number;
+  code: string;
+  coefficient: number;
+  exams: Array<Exam>;
+  name: string;
+}

src/iut/signatures/models/ReportCard.ts

@@ -0,0 +1,7 @@
+import type { Semester } from "./Semester";
+
+export interface ReportCard {
+  fullName: string;
+  promotion: string;
+  semesters: Array<Semester>;
+}

src/iut/signatures/models/Semester.ts

@@ -0,0 +1,6 @@
+import type { TeachingUnit } from "./TeachingUnit";
+
+export interface Semester {
+  name: string;
+  units: Array<TeachingUnit>;
+}

src/iut/signatures/models/TeachingUnit.ts

@@ -0,0 +1,9 @@
+import type { Module } from "./Module";
+
+export interface TeachingUnit {
+  average: null | number;
+  code: string;
+  coefficient: number;
+  modules: Array<Module>;
+  name: string;
+}

src/iut/signatures/models/index.ts

@@ -0,0 +1,5 @@
+export type { Exam } from "./Exam";
+export type { Module } from "./Module";
+export type { ReportCard } from "./ReportCard";
+export type { Semester } from "./Semester";
+export type { TeachingUnit } from "./TeachingUnit";

tests/signatures/empty.test.ts

@@ -13,7 +13,7 @@ describe("iut/signatures", () => {
     expect(Signatures.oauth2.scopes).toEqual(["openid", "profile"]);
   });
 
-  // it("should parse correctly the report card", () => {
-  //   const report = Signatures.parse(html as unknown as string);
-  // });
+  it("should parse correctly the report card", () => {
+    const report = Signatures.parse(html as unknown as string);
+  });
 });