@lime1/esprit-ts 1.0.0

package/dist/index.js

@@ -0,0 +1,659 @@
+// src/index.ts
+import axios from "axios";
+import { wrapper } from "axios-cookiejar-support";
+import { CookieJar } from "tough-cookie";
+import * as cheerio2 from "cheerio";
+import qs from "qs";
+
+// src/utils.ts
+import * as cheerio from "cheerio";
+function extractASPNetFormData(html) {
+  const $ = cheerio.load(html);
+  return {
+    __VIEWSTATE: $("input#__VIEWSTATE").val() ?? "",
+    __VIEWSTATEGENERATOR: $("input#__VIEWSTATEGENERATOR").val() ?? "",
+    __EVENTVALIDATION: $("input#__EVENTVALIDATION").val() ?? ""
+  };
+}
+function findInputByPatterns($, patterns) {
+  for (const pattern of patterns) {
+    const lowerPattern = pattern.toLowerCase();
+    const byId = $(`input`).filter((_, el) => {
+      const id = $(el).attr("id")?.toLowerCase() ?? "";
+      return id.includes(lowerPattern);
+    }).first();
+    if (byId.length > 0) return byId;
+    const byName = $(`input`).filter((_, el) => {
+      const name = $(el).attr("name")?.toLowerCase() ?? "";
+      return name.includes(lowerPattern);
+    }).first();
+    if (byName.length > 0) return byName;
+  }
+  return null;
+}
+function getInputName($input, $) {
+  return $input.attr("name") ?? $input.attr("id") ?? "";
+}
+function parseEuropeanNumber(value) {
+  if (!value || value.trim() === "") return null;
+  const normalized = value.trim().replace(",", ".");
+  const parsed = parseFloat(normalized);
+  return isNaN(parsed) ? null : parsed;
+}
+function parseGrades(headers, rows) {
+  const grades = [];
+  const headerLower = headers.map((h) => h.toLowerCase());
+  const designationIdx = headerLower.findIndex((h) => h.includes("designation") || h.includes("module"));
+  const coefIdx = headerLower.findIndex((h) => h.includes("coef"));
+  const ccIdx = headerLower.findIndex((h) => h.includes("cc") || h.includes("note_cc"));
+  const tpIdx = headerLower.findIndex((h) => h.includes("tp") || h.includes("note_tp"));
+  const examIdx = headerLower.findIndex((h) => h.includes("exam") || h.includes("note_exam"));
+  for (const row of rows) {
+    if (row.length === 0) continue;
+    grades.push({
+      designation: designationIdx >= 0 ? row[designationIdx] ?? "" : row[0] ?? "",
+      coefficient: coefIdx >= 0 ? parseEuropeanNumber(row[coefIdx]) : null,
+      noteCC: ccIdx >= 0 ? parseEuropeanNumber(row[ccIdx]) : null,
+      noteTP: tpIdx >= 0 ? parseEuropeanNumber(row[tpIdx]) : null,
+      noteExam: examIdx >= 0 ? parseEuropeanNumber(row[examIdx]) : null
+    });
+  }
+  return grades;
+}
+function calculateModuleAverage(grade) {
+  const { noteExam, noteCC, noteTP } = grade;
+  if (noteExam === null) return null;
+  if (noteTP === null) {
+    if (noteCC === null) {
+      return noteExam;
+    } else {
+      return noteExam * 0.6 + noteCC * 0.4;
+    }
+  } else if (noteCC === null) {
+    return noteExam * 0.8 + noteTP * 0.2;
+  } else {
+    return noteExam * 0.5 + noteCC * 0.3 + noteTP * 0.2;
+  }
+}
+function calculateGradeSummary(grades) {
+  const gradesWithAverage = grades.map((grade) => ({
+    ...grade,
+    moyenne: calculateModuleAverage(grade)
+  }));
+  let totalWeightedSum = 0;
+  let totalCoefficient = 0;
+  for (const grade of gradesWithAverage) {
+    if (grade.moyenne !== null && grade.coefficient !== null) {
+      totalWeightedSum += grade.moyenne * grade.coefficient;
+      totalCoefficient += grade.coefficient;
+    }
+  }
+  const totalAverage = totalCoefficient > 0 ? totalWeightedSum / totalCoefficient : null;
+  return {
+    grades: gradesWithAverage,
+    totalAverage,
+    totalCoefficient
+  };
+}
+function parseTable($, table) {
+  const rowElements = table.find("tr");
+  const headers = [];
+  const rows = [];
+  rowElements.each((index, row) => {
+    const cells = [];
+    if (index === 0) {
+      $(row).find("th").each((_, cell) => {
+        headers.push($(cell).text().trim());
+      });
+    } else {
+      $(row).find("td").each((_, cell) => {
+        cells.push($(cell).text().trim());
+      });
+      if (cells.length > 0) {
+        rows.push(cells);
+      }
+    }
+  });
+  return { headers, rows };
+}
+function isLoginPage(url) {
+  const lower = url.toLowerCase();
+  return lower.includes("default.aspx") || lower.includes("login");
+}
+function isHomePage(url) {
+  return url.toLowerCase().includes("accueil.aspx");
+}
+
+// src/index.ts
+var EspritClient = class {
+  client;
+  cookieJar;
+  debug;
+  // URL constants
+  LOGIN_URL = "https://esprit-tn.com/esponline/online/default.aspx";
+  HOME_URL = "https://esprit-tn.com/esponline/Etudiants/Accueil.aspx";
+  GRADES_URL = "https://esprit-tn.com/ESPOnline/Etudiants/Resultat2021.aspx";
+  ABSENCES_URL = "https://esprit-tn.com/ESPOnline/Etudiants/absenceetud.aspx";
+  CREDITS_URL = "https://esprit-tn.com/ESPOnline/Etudiants/Historique_Cr%C3%A9dit.aspx";
+  SCHEDULES_URL = "https://esprit-tn.com/ESPOnline/Etudiants/Emplois.aspx";
+  LOGOUT_URLS = [
+    "https://esprit-tn.com/esponline/Etudiants/Deconnexion.aspx",
+    "https://esprit-tn.com/esponline/online/Deconnexion.aspx"
+  ];
+  /**
+   * Create a new EspritClient instance.
+   * 
+   * @param config - Optional configuration options
+   */
+  constructor(config = {}) {
+    this.debug = config.debug ?? false;
+    this.cookieJar = new CookieJar();
+    this.client = wrapper(axios.create({
+      jar: this.cookieJar,
+      withCredentials: true,
+      timeout: config.timeout ?? 3e4,
+      headers: {
+        "User-Agent": config.userAgent ?? "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
+        "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
+        "Accept-Language": "en-US,en;q=0.5",
+        "Connection": "keep-alive"
+      },
+      maxRedirects: 5
+    }));
+  }
+  /**
+   * Log a debug message if debug mode is enabled.
+   */
+  log(message, ...args) {
+    if (this.debug) {
+      console.log(`[EspritClient] ${message}`, ...args);
+    }
+  }
+  /**
+   * Login to the ESPRIT student portal.
+   * 
+   * This handles the multi-step ASP.NET login flow:
+   * 1. Load login page and extract ViewState
+   * 2. Submit student ID with checkbox
+   * 3. Submit password
+   * 
+   * @param identifier - Student ID
+   * @param password - Student password
+   * @returns LoginResult with success status and cookies
+   */
+  async login(identifier, password) {
+    try {
+      this.log("Loading login page...");
+      const initialResponse = await this.client.get(this.LOGIN_URL);
+      if (initialResponse.status !== 200) {
+        return { success: false, cookies: [], message: "Failed to load login page" };
+      }
+      let $ = cheerio2.load(initialResponse.data);
+      let formData = extractASPNetFormData(initialResponse.data);
+      const idInput = findInputByPatterns($, ["textbox3", "textbox1"]);
+      const idFieldName = idInput ? getInputName(idInput, $) : "ctl00$ContentPlaceHolder1$TextBox3";
+      this.log("Found ID field:", idFieldName);
+      const checkbox = $('input[type="checkbox"]').first();
+      const checkboxName = checkbox.length > 0 ? getInputName(checkbox, $) : "";
+      this.log("Found checkbox:", checkboxName);
+      if (checkboxName) {
+        const checkboxFormData = {
+          ...formData,
+          [idFieldName]: identifier,
+          [checkboxName]: "on",
+          __EVENTTARGET: checkboxName,
+          __EVENTARGUMENT: ""
+        };
+        this.log("Checking checkbox...");
+        const checkboxResponse = await this.client.post(
+          this.LOGIN_URL,
+          qs.stringify(checkboxFormData),
+          { headers: { "Content-Type": "application/x-www-form-urlencoded" } }
+        );
+        if (checkboxResponse.status === 200) {
+          $ = cheerio2.load(checkboxResponse.data);
+          formData = extractASPNetFormData(checkboxResponse.data);
+          const continueButton = findInputByPatterns($, ["continuer", "continue"]);
+          if (continueButton) {
+            const continueButtonName = getInputName(continueButton, $);
+            this.log("Clicking continue button:", continueButtonName);
+            const continueFormData = {
+              ...formData,
+              [idFieldName]: identifier,
+              [checkboxName]: "on",
+              __EVENTTARGET: continueButtonName,
+              __EVENTARGUMENT: ""
+            };
+            const continueResponse = await this.client.post(
+              this.LOGIN_URL,
+              qs.stringify(continueFormData),
+              { headers: { "Content-Type": "application/x-www-form-urlencoded" } }
+            );
+            if (continueResponse.status === 200) {
+              $ = cheerio2.load(continueResponse.data);
+              formData = extractASPNetFormData(continueResponse.data);
+            }
+          }
+        }
+      }
+      const suivantButton = findInputByPatterns($, ["button3", "button1", "suivant", "next"]);
+      const suivantButtonName = suivantButton ? getInputName(suivantButton, $) : "ctl00$ContentPlaceHolder1$Button3";
+      this.log("Clicking Suivant button:", suivantButtonName);
+      const suivantFormData = {
+        ...formData,
+        [idFieldName]: identifier,
+        ...checkboxName ? { [checkboxName]: "on" } : {},
+        __EVENTTARGET: suivantButtonName,
+        __EVENTARGUMENT: ""
+      };
+      const suivantResponse = await this.client.post(
+        this.LOGIN_URL,
+        qs.stringify(suivantFormData),
+        { headers: { "Content-Type": "application/x-www-form-urlencoded" } }
+      );
+      if (suivantResponse.status !== 200) {
+        return { success: false, cookies: [], message: "Failed to submit ID" };
+      }
+      $ = cheerio2.load(suivantResponse.data);
+      const passwordField = findInputByPatterns($, ["textbox7"]);
+      const idFieldStillPresent = findInputByPatterns($, ["textbox3"]);
+      if (idFieldStillPresent && !passwordField) {
+        return { success: false, cookies: [], message: "Identifiant incorrect !" };
+      }
+      this.log("Now on password page...");
+      formData = extractASPNetFormData(suivantResponse.data);
+      const passwordFieldName = passwordField ? getInputName(passwordField, $) : "ctl00$ContentPlaceHolder1$TextBox7";
+      const connexionButton = findInputByPatterns($, ["buttonetudiant", "button2", "connexion", "connect"]);
+      const connexionButtonName = connexionButton ? getInputName(connexionButton, $) : "ctl00$ContentPlaceHolder1$ButtonEtudiant";
+      this.log("Submitting password with button:", connexionButtonName);
+      const passwordFormData = {
+        ...formData,
+        [passwordFieldName]: password,
+        __EVENTTARGET: connexionButtonName,
+        __EVENTARGUMENT: ""
+      };
+      const loginResponse = await this.client.post(
+        suivantResponse.request?.res?.responseUrl ?? this.LOGIN_URL,
+        qs.stringify(passwordFormData),
+        {
+          headers: { "Content-Type": "application/x-www-form-urlencoded" },
+          maxRedirects: 5
+        }
+      );
+      const finalUrl = loginResponse.request?.res?.responseUrl ?? "";
+      this.log("Final URL:", finalUrl);
+      $ = cheerio2.load(loginResponse.data);
+      const passwordStillPresent = findInputByPatterns($, ["textbox7"]);
+      const stillOnLoginPage = isLoginPage(finalUrl);
+      if (stillOnLoginPage && passwordStillPresent) {
+        return { success: false, cookies: [], message: "Mot de passe incorrect !" };
+      }
+      const successIndicators = [
+        "Vous pouvez consulter dans cet espace",
+        "Espace Etudiant",
+        "Accueil.aspx",
+        "Label2",
+        "Label3"
+      ];
+      const onHomePage = isHomePage(finalUrl);
+      const hasSuccessIndicator = successIndicators.some(
+        (indicator) => loginResponse.data.includes(indicator)
+      );
+      if (!stillOnLoginPage && (onHomePage || hasSuccessIndicator)) {
+        this.log("Login successful!");
+        const cookies = await this.getCookies();
+        return { success: true, cookies, message: "Login successful!" };
+      }
+      return { success: false, cookies: [], message: "Login failed - unknown error" };
+    } catch (error) {
+      const message = error instanceof Error ? error.message : "Unknown error";
+      this.log("Login error:", message);
+      return { success: false, cookies: [], message };
+    }
+  }
+  /**
+   * Logout from the ESPRIT portal.
+   * 
+   * @returns True if logout was successful
+   */
+  async logout() {
+    try {
+      this.log("Attempting logout via postback...");
+      const homeResponse = await this.client.get(this.HOME_URL, { maxRedirects: 5 });
+      if (homeResponse.status === 200 && !isLoginPage(homeResponse.request?.res?.responseUrl ?? "")) {
+        const formData = extractASPNetFormData(homeResponse.data);
+        const logoutFormData = {
+          ...formData,
+          __EVENTTARGET: "ctl00$LinkButton1",
+          __EVENTARGUMENT: ""
+        };
+        await this.client.post(
+          this.HOME_URL,
+          qs.stringify(logoutFormData),
+          { headers: { "Content-Type": "application/x-www-form-urlencoded" } }
+        );
+        this.log("Logout successful via postback");
+        return true;
+      }
+      for (const logoutUrl of this.LOGOUT_URLS) {
+        try {
+          this.log("Trying logout URL:", logoutUrl);
+          await this.client.get(logoutUrl, { maxRedirects: 5 });
+          this.log("Logout successful via URL");
+          return true;
+        } catch {
+          continue;
+        }
+      }
+      this.log("Clearing cookies...");
+      this.cookieJar.removeAllCookiesSync();
+      return true;
+    } catch (error) {
+      this.log("Logout error:", error);
+      this.cookieJar.removeAllCookiesSync();
+      return true;
+    }
+  }
+  /**
+   * Get current session cookies.
+   * 
+   * @returns Array of Cookie objects
+   */
+  async getCookies() {
+    const cookies = await this.cookieJar.getCookies(this.LOGIN_URL);
+    return cookies.map((cookie) => ({
+      name: cookie.key,
+      value: cookie.value,
+      domain: cookie.domain ?? "",
+      path: cookie.path ?? "/"
+    }));
+  }
+  /**
+   * Get student grades.
+   * 
+   * @returns Array of Grade objects or null if page cannot be loaded
+   */
+  async getGrades() {
+    try {
+      const response = await this.client.get(this.GRADES_URL, { maxRedirects: 5 });
+      if (isLoginPage(response.request?.res?.responseUrl ?? "")) {
+        this.log("Session expired - redirected to login");
+        return null;
+      }
+      const $ = cheerio2.load(response.data);
+      const h1Tag = $("h1").filter(
+        (_, el) => $(el).text().includes("Notes Des Modules")
+      );
+      if (h1Tag.length === 0) {
+        this.log("Page does not contain expected content");
+        return null;
+      }
+      const table = $("#ContentPlaceHolder1_GridView1");
+      if (table.length === 0) {
+        this.log("Grades table not found");
+        return null;
+      }
+      const { headers, rows } = parseTable($, table);
+      return parseGrades(headers, rows);
+    } catch (error) {
+      this.log("Error getting grades:", error);
+      return null;
+    }
+  }
+  /**
+   * Get grades with calculated averages.
+   * 
+   * @returns GradeSummary with grades and total average, or null if page cannot be loaded
+   */
+  async getGradesWithAverage() {
+    const grades = await this.getGrades();
+    if (!grades) return null;
+    return calculateGradeSummary(grades);
+  }
+  /**
+   * Get student absences.
+   * 
+   * @returns Array of Absence records (as key-value objects) or null
+   */
+  async getAbsences() {
+    try {
+      const response = await this.client.get(this.ABSENCES_URL, { maxRedirects: 5 });
+      if (isLoginPage(response.request?.res?.responseUrl ?? "")) {
+        this.log("Session expired - redirected to login");
+        return null;
+      }
+      const $ = cheerio2.load(response.data);
+      const strongTag = $("strong").filter(
+        (_, el) => $(el).text().includes("Absence")
+      );
+      if (strongTag.length === 0) {
+        this.log("Page does not contain expected content");
+        return null;
+      }
+      const table = $("#ContentPlaceHolder1_GridView2");
+      if (table.length === 0) {
+        this.log("Absences table not found");
+        return null;
+      }
+      const { headers, rows } = parseTable($, table);
+      return rows.map((row) => {
+        const absence = {};
+        headers.forEach((header, index) => {
+          absence[header] = row[index] ?? "";
+        });
+        return absence;
+      });
+    } catch (error) {
+      this.log("Error getting absences:", error);
+      return null;
+    }
+  }
+  /**
+   * Get student credit history.
+   * 
+   * @returns Array of Credit records (as key-value objects) or null
+   */
+  async getCredits() {
+    try {
+      const response = await this.client.get(this.CREDITS_URL, { maxRedirects: 5 });
+      if (isLoginPage(response.request?.res?.responseUrl ?? "")) {
+        this.log("Session expired - redirected to login");
+        return null;
+      }
+      const $ = cheerio2.load(response.data);
+      let table = $("#ContentPlaceHolder1_GridView1");
+      if (table.length === 0) {
+        $("table").each((_, el) => {
+          const firstRow = $(el).find("tr").first();
+          const headers2 = firstRow.find("th").map((_2, th) => $(th).text().trim()).get();
+          if (headers2.some((h) => h.includes("Ann\xE9e") || h.includes("enseignement"))) {
+            table = $(el);
+            return false;
+          }
+        });
+      }
+      if (table.length === 0) {
+        this.log("Credits table not found");
+        return null;
+      }
+      const { headers, rows } = parseTable($, table);
+      return rows.map((row) => {
+        const credit = {};
+        headers.forEach((header, index) => {
+          credit[header] = row[index] ?? "";
+        });
+        return credit;
+      });
+    } catch (error) {
+      this.log("Error getting credits:", error);
+      return null;
+    }
+  }
+  /**
+   * Get available schedules.
+   * 
+   * @returns Array of Schedule objects or null
+   */
+  async getSchedules() {
+    try {
+      const response = await this.client.get(this.SCHEDULES_URL, { maxRedirects: 5 });
+      if (isLoginPage(response.request?.res?.responseUrl ?? "")) {
+        this.log("Session expired - redirected to login");
+        return null;
+      }
+      const $ = cheerio2.load(response.data);
+      const strongTag = $("strong").filter(
+        (_, el) => $(el).text().includes("Emploi du temps")
+      );
+      if (strongTag.length === 0) {
+        this.log("Page does not contain expected content");
+        return null;
+      }
+      const table = $("#ContentPlaceHolder1_GridView1");
+      if (table.length === 0) {
+        this.log("Schedules table not found");
+        return null;
+      }
+      const schedules = [];
+      table.find("tr").each((index, row) => {
+        if (index === 0) return;
+        const cells = $(row).find("td");
+        const rawData = [];
+        let name = "";
+        let link = null;
+        cells.each((i, cell) => {
+          const cellText = $(cell).text().trim();
+          const cellLink = $(cell).find("a");
+          if (i === 0) {
+            name = cellText;
+          }
+          if (cellLink.length > 0) {
+            const href = cellLink.attr("href") ?? "";
+            const match = href.match(/'([^']+)'/);
+            link = match ? match[1] : href;
+          }
+          rawData.push(cellText);
+        });
+        if (name) {
+          schedules.push({ name, link, rawData });
+        }
+      });
+      return schedules;
+    } catch (error) {
+      this.log("Error getting schedules:", error);
+      return null;
+    }
+  }
+  /**
+   * Get student name from the home page.
+   * 
+   * @returns Student name or null
+   */
+  async getStudentName() {
+    try {
+      const response = await this.client.get(this.HOME_URL, { maxRedirects: 5 });
+      if (isLoginPage(response.request?.res?.responseUrl ?? "")) {
+        this.log("Session expired - redirected to login");
+        return null;
+      }
+      const $ = cheerio2.load(response.data);
+      const selectors = [
+        "#Label2",
+        "#ContentPlaceHolder1_Label2",
+        "span.h4.text-info"
+      ];
+      for (const selector of selectors) {
+        const element = $(selector);
+        if (element.length > 0) {
+          const text = element.text().trim();
+          if (text) return text;
+        }
+      }
+      this.log("Student name not found");
+      return null;
+    } catch (error) {
+      this.log("Error getting student name:", error);
+      return null;
+    }
+  }
+  /**
+   * Get student class from the home page.
+   * 
+   * @returns Student class name or null
+   */
+  async getStudentClass() {
+    try {
+      const response = await this.client.get(this.HOME_URL, { maxRedirects: 5 });
+      if (isLoginPage(response.request?.res?.responseUrl ?? "")) {
+        this.log("Session expired - redirected to login");
+        return null;
+      }
+      const $ = cheerio2.load(response.data);
+      const selectors = [
+        "#Label3",
+        "#ContentPlaceHolder1_Label3"
+      ];
+      for (const selector of selectors) {
+        const element = $(selector);
+        if (element.length > 0) {
+          const text = element.text().trim();
+          if (text) return text;
+        }
+      }
+      this.log("Student class not found");
+      return null;
+    } catch (error) {
+      this.log("Error getting student class:", error);
+      return null;
+    }
+  }
+  /**
+   * Get both student name and class in one call.
+   * 
+   * @returns StudentInfo object with name and className
+   */
+  async getStudentInfo() {
+    try {
+      const response = await this.client.get(this.HOME_URL, { maxRedirects: 5 });
+      if (isLoginPage(response.request?.res?.responseUrl ?? "")) {
+        this.log("Session expired - redirected to login");
+        return { name: null, className: null };
+      }
+      const $ = cheerio2.load(response.data);
+      let name = null;
+      for (const selector of ["#Label2", "#ContentPlaceHolder1_Label2"]) {
+        const element = $(selector);
+        if (element.length > 0) {
+          const text = element.text().trim();
+          if (text) {
+            name = text;
+            break;
+          }
+        }
+      }
+      let className = null;
+      for (const selector of ["#Label3", "#ContentPlaceHolder1_Label3"]) {
+        const element = $(selector);
+        if (element.length > 0) {
+          const text = element.text().trim();
+          if (text) {
+            className = text;
+            break;
+          }
+        }
+      }
+      return { name, className };
+    } catch (error) {
+      this.log("Error getting student info:", error);
+      return { name: null, className: null };
+    }
+  }
+};
+var index_default = EspritClient;
+export {
+  EspritClient,
+  calculateGradeSummary,
+  calculateModuleAverage,
+  index_default as default
+};
+//# sourceMappingURL=index.js.map