Enhance ICS generation: Add requested timetable parameter and improve lesson details formatting (#7)

Author: NLion74

src/ics.ts

@@ -1,7 +1,11 @@
 import ical, { ICalEventStatus } from "ical-generator";
 import { Lesson } from "./types";
 
-export function lessonsToIcs(lessons: Lesson[], timezone: string): string {
+export function lessonsToIcs(
+    lessons: Lesson[],
+    timezone: string,
+    requestedTimetable: string
+): string {
     const cal = ical({ name: "WebUntis Timetable", timezone });
 
     for (const l of lessons) {
@@ -10,6 +14,18 @@ export function lessonsToIcs(lessons: Lesson[], timezone: string): string {
         const endHour = Math.floor(l.endTime / 100);
         const endMinute = l.endTime % 100;
 
+        const teacherCount = l.teacher.length;
+        const teacherList = l.teacher.slice(0, 3).join(", ");
+        const teacherSummary =
+            teacherCount > 3
+                ? `${teacherList} ...+${teacherCount - 3}`
+                : teacherList;
+
+        const classCount = l.class.length;
+        const classList = l.class.slice(0, 3).join(", ");
+        const classSummary =
+            classCount > 3 ? `${classList} ...+${classCount - 3}` : classList;
+
         cal.createEvent({
             start: new Date(
                 l.date.getFullYear(),
@@ -25,9 +41,14 @@ export function lessonsToIcs(lessons: Lesson[], timezone: string): string {
                 endHour,
                 endMinute
             ),
-            summary: `${l.subject} (${l.class})`,
-            description: `Teacher: ${l.teacher}\nRoom: ${l.room}`,
+            summary: `${l.subject} (${teacherSummary}) - ${classSummary}`,
             location: l.room,
+            description: `Subject: ${l.subject}\nTeacher: ${l.teacher.join(
+                ", "
+            )}\nRoom: ${l.room}\nClass: ${l.class.join(
+                ", "
+            )}\nTimetable: ${requestedTimetable}`,
+
             status: "CONFIRMED" as ICalEventStatus,
         });
     }

src/index.ts

@@ -47,7 +47,8 @@ async function main() {
             const lessons = await fetchTimetable(user, startDate, endDate);
             const ics = lessonsToIcs(
                 lessons,
-                configManager.config.timezone || "Europe/Berlin"
+                configManager.config.timezone || "Europe/Berlin",
+                user.friendlyName
             );
 
             return sendIcs(res, user.friendlyName, ics);
@@ -102,7 +103,8 @@ async function main() {
 
             const ics = lessonsToIcs(
                 lessons,
-                configManager.config.timezone || "Europe/Berlin"
+                configManager.config.timezone || "Europe/Berlin",
+                `${user.friendlyName} - ${type || "own"} ${id || ""}`
             );
 
             icsCache.set(cacheKey, ics);

src/types.ts

@@ -18,9 +18,9 @@ export interface Lesson {
     startTime: number;
     endTime: number;
     subject: string;
-    teacher: string;
+    teacher: string[];
     room: string;
-    class: string;
+    class: string[];
     date: Date;
 }
 

src/webuntis.ts

@@ -138,12 +138,11 @@ export async function fetchTimetable(
                 startTime: entry.startTime,
                 endTime: entry.endTime,
                 subject: entry.su?.[0]?.name || "Event",
-                teacher: entry.te?.[0]?.name || "Unknown Teacher",
+                teacher: entry.te?.map((t: any) => t.name) || [
+                    "Unknown Teacher",
+                ],
                 room: entry.ro?.[0]?.name || "Unknown Room",
-                class:
-                    entry.kl?.[1]?.longname ||
-                    entry.kl?.[0]?.longname ||
-                    "Unknown Class",
+                class: entry.kl?.map((k: any) => k.name) || ["Unknown Class"],
                 date: parseUntisDate(entry.date),
             }));