Timeline

The Timeline module combines student-centric activity tracking (new assignments, grades, school messages) and smart data analysis across academic and school life behaviors to reveal valuable performance correlations.

---

🚀 Getting Started

Let's read the latest events from the student's personalized timeline:

import { getTimeline } from "linkdirecte";

const events = await getTimeline();

console.log(`There are ${events.length} recent events on your feed:`);

events.slice(0, 5).forEach(event => {
  console.log(`- [${event.typeElement}] ${event.titre || "Activity update"}`);
  if (event.soustitre) console.log(`  Detail: ${event.soustitre}`);
});

Let's run the smart correlation engine to see statistical performance trends!

import { correlate } from "linkdirecte";

const correlations = await correlate();

correlations.forEach(insight => {
  if (insight.type === "gradeTrend") {
    console.log(`📈 Trend in [${insight.subject}]: Overall calculated average is ${insight.data.average.toFixed(2)}/20 (Based on ${insight.observations} observations).`);
  } else if (insight.type === "gradeVsDayOfWeek") {
    console.log(`📅 Weekly patterns in [${insight.subject}]:`);
    for (const [day, average] of Object.entries(insight.data)) {
      console.log(`   • ${day}: ${average.toFixed(1)}/20`);
    }
  }
});

---

📖 API Reference

getTimeline

Retrieves a chronologically ordered list of events relevant to the logged-in student.

function getTimeline(): Promise<TimelineEntry[]>

---

getCommonTimeline

Fetches general school notices, bulletins, and shared announcements. Linkdirecte automatically decodes French HTML "sticky notes" (stickyNotes) for you in the process.

function getCommonTimeline(): Promise<any>

---

correlate

Runs an advanced correlation pass across different modules (grades and attendance) to construct statistical insights.

Note: Linkdirecte only includes subjects in the analysis that have at least 5 graded entries to maintain statistical reliability.

function correlate(): Promise<Correlation[]>

---

🗂️ Type Definitions

TimelineEntry

The properties of TimelineEntry are returned as raw EcoleDirecte API keys (no translation is performed by the SDK):

Property	Type	Description
id	number	Unique ID of the event.
typeElement	string	The event code (e.g., "Note", "Devoir", "Viescolaire"). (raw key)
date	Date	Timestamp of when the event occurred. (raw key)
titre	string (optional)	Primary description of the event. (raw key)
soustitre	string (optional)	Supporting description or sub-label. (raw key)
contenu	string (optional)	Extended body text. (raw key)

Correlation

interface Correlation {
  type: CorrelationType;             // Category of correlation analysis
  subject: string;                   // Subject name being analyzed
  finding: string;                   // Brief summary of findings
  data: Record<string, number>;      // Key-value statistics map (averages, days, etc.)
  confidence: number;                // Statistical confidence score (from 0 to 1)
  observations: number;              // Number of entries/data-points analyzed
}

CorrelationType

type CorrelationType =
  | "gradeVsPresence"
  | "gradeVsDayOfWeek"
  | "gradeVsTimeOfDay"
  | "homeworkVsGrade"
  | "gradeTrend";