@ranzenjs/client 0.2.1 → 0.3.0

package/dist/apps/lessons/parse.js

@@ -1,39 +1,36 @@
 import { layoutChanged } from '../../errors.js';
-import { all, attr, cells, hasClass, one, ownText, rows, text } from '../../html.js';
+import { all, attr, cells, hasClass, one, ownText, rawText, rows, text } from '../../html.js';
 import { ignoreDrift, isoDate, parseCount, queryParam } from '../../util.js';
 export function parseOverview(document, drift = ignoreDrift) {
     const folders = one('#mappen', document);
     if (!folders)
         throw layoutChanged('#mappen on the lessons page');
     const cards = all('.thumbnail', folders);
-    // An empty #mappen is a valid account without courses; course links outside cards are not.
+    // An empty #mappen is a valid account without courses; a skipped course would read as gone.
+    const links = all('a[href*="sus_view"]', folders);
     const carded = new Set(cards.flatMap((card) => all('a[href*="sus_view"]', card)));
-    if (all('a[href*="sus_view"]', folders).some((link) => !carded.has(link))) {
-        drift('The lessons page lists courses outside known cards.');
+    if (links.some((link) => !carded.has(link))) {
+        throw layoutChanged('.thumbnail cards around every course in #mappen');
     }
     const latest = one('#aktuellTable', document);
     if (!latest && one('tr[data-entry]', document)) {
         drift('The lessons page lists entries outside #aktuellTable.');
     }
+    const courses = cards.map((card) => {
+        const id = queryParam(attr(one('a[href*="sus_view"]', card), 'href'), 'id');
+        if (!id)
+            throw layoutChanged('a course link in every .thumbnail card');
+        return {
+            id,
+            name: attr(one('h2 [title]', card), 'title') ?? text(one('h2', card)),
+            teachers: all('button.dropdown-toggle[title]', card).map(teacher),
+            marks: count(one('a.btn-info[href*="#leistungen"]', card)),
+            undoneHomework: count(one('a.btn-danger', card)),
+            upcomingEntries: count(one('a.btn-warning', card))
+        };
+    });
     return {
-        courses: cards.flatMap((card) => {
-            const id = queryParam(attr(one('a[href*="sus_view"]', card), 'href'), 'id');
-            if (!id) {
-                drift('A course card has no course link.');
-                return [];
-            }
-            const name = attr(one('h2 [title]', card), 'title') ?? text(one('h2', card));
-            return [
-                {
-                    id,
-                    name,
-                    teachers: all('button.dropdown-toggle[title]', card).map(teacher),
-                    marks: count(one('a.btn-info[href*="#leistungen"]', card)),
-                    undoneHomework: count(one('a.btn-danger', card)),
-                    upcomingEntries: count(one('a.btn-warning', card))
-                }
-            ];
-        }),
+        courses,
         latest: entryRows(rows(latest), 'A latest entry', drift).map((row) => ({
             course: { id: attr(row, 'data-book') ?? '', name: text(one('.name', row)) },
             teachers: all('.teacher button[title]', row).map(teacher),
@@ -111,7 +108,7 @@ function historyEntry(row, drift) {
     return {
         ...emptyEntry(attr(row, 'data-entry') ?? ''),
         date: entryDate(text(when), 'A history row', drift),
-        periods: periods(text(when && one('small', when)), drift),
+        periods: periods(rawText(when && one('small', when)), drift),
         topic: text(body && one(':scope > b', body)) || null,
         content: text(contentOf(body), true) || null,
         homework: historyHomework(body, drift),
@@ -171,7 +168,7 @@ function submission(group, drift) {
     return [
         {
             id,
-            name: ownText(button),
+            name: rawText(button, true),
             open: hasClass(button, 'btn-warning'),
             uploaded: text(button && one('.badge', button)) || null,
             due: day && time ? `${day}T${time[1].padStart(2, '0')}:${time[2]}` : day
@@ -185,7 +182,7 @@ function parseMarks(document, drift) {
         const [name, date, value, ...rest] = cells(row);
         const last = marks.at(-1);
         if (name && date && value && !rest.length) {
-            marks.push({ name: text(name), date: text(date), value: text(value), comment: null });
+            marks.push({ name: rawText(name), date: rawText(date), value: text(value), comment: null });
         }
         else if (last &&
             name &&
@@ -300,7 +297,7 @@ function periods(label, drift) {
     const match = /^(\d+)\.?(?:\s*[-–]\s*(\d+)\.?)?(?:\s*Stunden?)?$/.exec(label.trim());
     if (!match) {
         drift('A history row has unreadable periods.');
-        return null;
+        return { from: null, to: null, label };
     }
     const from = Number(match[1]);
     return { from, to: match[2] ? Number(match[2]) : from, label };

package/dist/apps/lessons/types.d.ts

@@ -5,8 +5,9 @@ export interface Teacher {
     lastName: string | null;
 }
 export interface Periods {
-    from: number;
-    to: number;
+    /** Null with `to` when the label names no period numbers, e.g. "08:00 - 09:30". */
+    from: number | null;
+    to: number | null;
     /** The portal's wording, unchanged, e.g. "1. - 2. Stunde". */
     label: string;
 }
@@ -22,6 +23,7 @@ export interface EntryFile {
 }
 export interface Submission {
     id: string;
+    /** As written, so it can serve as a key. */
     name: string;
     open: boolean;
     /** The portal's badge, e.g. "2" files handed in; null without one. */
@@ -70,6 +72,7 @@ export interface Overview {
     attendance: AttendanceSummary[];
 }
 export interface Mark {
+    /** As written, like `date`, so it can serve as a key. */
     name: string;
     /** As shown by the portal, which omits the year, e.g. "Do, 17.09.". */
     date: string;

package/dist/html.d.ts

@@ -14,6 +14,8 @@ export declare function rows(table: Element | null | undefined): Element[];
  * Multiline keeps <br> and block breaks, for free text such as lesson content and homework.
  */
 export declare function text(node: Root | null | undefined, multiline?: boolean): string;
+/** Visible text with its whitespace as written, only trimmed, for names callers store as keys. */
+export declare function rawText(node: Element | null | undefined, own?: boolean): string;
 /** Only the element's own text, without that of badges or labels nested in it. */
 export declare function ownText(node: Element | null | undefined): string;
 export declare function attr(node: Element | null | undefined, name: string): string | undefined;

package/dist/html.js

@@ -73,6 +73,19 @@ export function text(node, multiline = false) {
         .replace(/\n{3,}/g, '\n\n')
         .trim();
 }
+/** Visible text with its whitespace as written, only trimmed, for names callers store as keys. */
+export function rawText(node, own = false) {
+    const parts = [];
+    const walk = (current) => {
+        if (isText(current))
+            parts.push(current.data);
+        else if (!own && isTag(current) && !hasClass(current, 'hidden_encoded')) {
+            current.children.forEach(walk);
+        }
+    };
+    node?.children.forEach(walk);
+    return parts.join('').trim();
+}
 /** Only the element's own text, without that of badges or labels nested in it. */
 export function ownText(node) {
     return (node?.children ?? [])

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ranzenjs/client",
-	"version": "0.2.1",
+	"version": "0.3.0",
 	"description": "Typed client for Schulportal Hessen (SPH, LANIS)",
 	"license": "MIT",
 	"author": "Suko",