Write the notes in an app, a school day at a time
The notes existed but there was nowhere to write them: a CLI command on a laptop, a tool call through Claude, or a file in a Docker volume. None of those is reachable from a phone in a lesson, which is where notes are actually taken. So: `/app`, served only when WEB_PASSWORD is set. A login, the day's notes, and a settings page for the Schulcloud token — the one surface here meant for a person rather than a program. The shape follows how the notes are written: one note per school day, one `##` heading per lesson, prose and lists and tables beneath. That turns out to be the design decision that matters, twice over. First, it is what lets WebUntis earn its keep. Opening a day with no note fills in that day's lessons — numbered, with times, teacher and room, cancellations dropped and substitutions marked. Retyping the timetable is exactly the work the second upstream exists to avoid, and "Stunden ergänzen" tops up a note started before the day ended without touching what is already written. Second, it changes how notes are indexed. A day note is indexed per lesson, not whole: search answers "my own note, Deutsch, 18.09.2026" rather than "my own note, Friday", and `list_notes subject=Deutsch` finds a day whose frontmatter names no subject at all. Indexed whole, every hit would read as a weekday and "what did we do in Deutsch" would match notes whose other five lessons were something else. `lessonHeading` and `subjectFromHeading` are a loop — the app writes the heading, the indexer reads the subject back out — and a test holds them to it. Notes taken in a lesson cannot be retaken, so the editor is built around not losing them: autosave, every keystroke mirrored to local storage, a save when the phone locks, and a fallback to the local copy when the request never arrives. A save that would overwrite a version the editor never saw is refused and the choice handed back — the notes folder is synced and open in more than one place, and a phone must not silently win over a laptop. `replaceNote` is separate from `writeNote` for that reason: never-overwrite is right for `add_note` and exactly wrong for an editor. WEB_PASSWORD is the first credential here a human types, so it is the first that can be guessed: scrypt at startup, never stored or compared in the clear, per-address rate limiting — which is not decoration, since the scrypt cost is itself a denial-of-service vector without it. The session is a signed HttpOnly SameSite=Strict cookie whose key is derived from the password, so changing it logs everyone out and there is no second secret to keep. It opens /api, because a session is the user, and never /mcp, because nothing in a browser speaks MCP. Also here, because the app made them matter: frontmatter now reads the indented `- item` list form editors write, so an Obsidian vault round-trips its tags; and a four-digit folder is a filing scheme, not a subject, so `2026/` does not file a school year under one. 357 tests; 106/107 smoke against the local instance, the one failure being the H5P service that instance does not run. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
101
src/http/api.ts
101
src/http/api.ts
@@ -12,7 +12,18 @@ import {
|
||||
type FsErrorCode,
|
||||
type WalkEntry,
|
||||
} from '../core/legacy-files.ts';
|
||||
import { filterNotes, NoteNotFound, readNoteAt, readNotes, writeNote } from '../core/notes.ts';
|
||||
import { dayLessons, dayNoteSkeleton, dayNoteTitle, missingHeadings } from '../core/day-note.ts';
|
||||
import { isCalendarDate, schoolToday } from '../core/dates.ts';
|
||||
import {
|
||||
dayNotePath,
|
||||
NoteConflict,
|
||||
NoteNotFound,
|
||||
filterNotes,
|
||||
readNoteAt,
|
||||
readNotes,
|
||||
replaceNote,
|
||||
writeNote,
|
||||
} from '../core/notes.ts';
|
||||
import { resolveWithin } from '../core/paths.ts';
|
||||
import { TokenRejected } from '../core/session-token.ts';
|
||||
import type { Services } from '../services.ts';
|
||||
@@ -307,6 +318,94 @@ export function createApiRouter(services: Services): Router {
|
||||
}
|
||||
});
|
||||
|
||||
// --- one school day, as the notes page edits it -------------------------
|
||||
//
|
||||
// The page is a Markdown editor for a single file, so these two are `GET the
|
||||
// day` and `PUT the day`. What makes them worth their own routes rather than
|
||||
// the generic ones above is the skeleton: WebUntis is the only thing that
|
||||
// knows which lessons a day held, and handing someone their day already laid
|
||||
// out is the difference between a note per day and an empty box.
|
||||
|
||||
router.get('/notes/day', async (req: Request, res: Response) => {
|
||||
const root = services.config.notesDir;
|
||||
if (!root) return res.status(503).json({ error: 'no_notes_dir', message: NO_NOTES_DIR });
|
||||
const date = stringParam(req.query.date) ?? schoolToday();
|
||||
if (!isCalendarDate(date)) {
|
||||
return res.status(400).json({ error: 'invalid', message: `Not a date in the calendar: ${date}.` });
|
||||
}
|
||||
try {
|
||||
const path = dayNotePath(date);
|
||||
const note = await readNoteAt(root, path).catch((error: unknown) => {
|
||||
if (error instanceof NoteNotFound) return undefined;
|
||||
throw error;
|
||||
});
|
||||
|
||||
// Never fatal, and reported rather than hidden: without a key, or with
|
||||
// WebUntis down, the page still has to open — it just cannot offer the
|
||||
// lessons, and saying so beats an empty skeleton that looks like a day
|
||||
// with no school.
|
||||
let lessons: ReturnType<typeof dayLessons> = [];
|
||||
let timetable: 'ok' | 'off' | 'unavailable' = services.untis ? 'ok' : 'off';
|
||||
if (services.untis) {
|
||||
try {
|
||||
lessons = dayLessons(await services.untis.timetable(date, date), date);
|
||||
} catch {
|
||||
timetable = 'unavailable';
|
||||
}
|
||||
}
|
||||
|
||||
return res.json({
|
||||
date,
|
||||
path,
|
||||
title: dayNoteTitle(date),
|
||||
exists: Boolean(note),
|
||||
text: note?.text ?? '',
|
||||
modifiedAt: note?.modifiedAt ?? null,
|
||||
timetable,
|
||||
lessons,
|
||||
skeleton: dayNoteSkeleton(lessons),
|
||||
// What the page would add to a note already started, so "top up the
|
||||
// day" never rewrites what is there.
|
||||
missing: note ? dayNoteSkeleton(missingHeadings(note.text, lessons)) : '',
|
||||
});
|
||||
} catch (error) {
|
||||
return fail(res, error, 'read a day note');
|
||||
}
|
||||
});
|
||||
|
||||
router.put('/notes/day', express.json({ limit: '2mb' }), async (req: Request, res: Response) => {
|
||||
const root = services.config.notesDir;
|
||||
if (!root) return res.status(503).json({ error: 'no_notes_dir', message: NO_NOTES_DIR });
|
||||
if (!services.config.notesWritable) {
|
||||
return res.status(403).json({ error: 'notes_readonly', message: 'This server was started with NOTES_READONLY.' });
|
||||
}
|
||||
const body = (req.body ?? {}) as { date?: unknown; text?: unknown; expectedModifiedAt?: unknown };
|
||||
const date = typeof body.date === 'string' ? body.date : '';
|
||||
if (!isCalendarDate(date)) {
|
||||
return res.status(400).json({ error: 'invalid', message: `Not a date in the calendar: ${date || '(none)'}.` });
|
||||
}
|
||||
if (typeof body.text !== 'string') {
|
||||
return res.status(400).json({ error: 'invalid', message: 'A day note needs its text.' });
|
||||
}
|
||||
try {
|
||||
const note = await replaceNote(
|
||||
root,
|
||||
dayNotePath(date),
|
||||
{ title: dayNoteTitle(date), text: body.text, date, source: 'notes-page' },
|
||||
typeof body.expectedModifiedAt === 'string' ? { expectedModifiedAt: body.expectedModifiedAt } : {},
|
||||
);
|
||||
return res.json({ path: note.path, modifiedAt: note.modifiedAt, bytes: note.bytes });
|
||||
} catch (error) {
|
||||
// A clash is the caller's to resolve, not a fault: the page shows both
|
||||
// and lets the person decide, which is the only safe answer when the
|
||||
// notes folder is synced and open in two places.
|
||||
if (error instanceof NoteConflict) {
|
||||
return res.status(409).json({ error: 'conflict', message: error.message, modifiedAt: error.modifiedAt });
|
||||
}
|
||||
return fail(res, error, 'save a day note');
|
||||
}
|
||||
});
|
||||
|
||||
router.get('/token', (_req: Request, res: Response) => {
|
||||
res.json(tokenStatus(services));
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user