feature(events): extended event list to support directories, save events by their id

This commit adds the ability to add events sorted by directories generated by
https://github.com/Malex14/hio_timetable_extractor. Each directory consists of a name
and potentially containing events and/or subdirectories. Events are stored in the
userconfig by their id. The event's name is now being saved in the corresponding
eventDetails. The filter functionality has been updated to support directories as well.

Author: Malex14

source/lib/all-events.ts

@@ -1,40 +1,106 @@
-import {readFile} from 'node:fs/promises';
+import {readFile, watch} from 'node:fs/promises';
+import type {
+	EventDirectory, EventId, Events,
+} from './types.ts';
 
-async function getAll(): Promise<string[]> {
-	const data = await readFile('eventfiles/all.txt', 'utf8');
-	const list = data.split('\n').filter(element => element !== '');
-	return list;
+const DIRECTORY_FILE = 'eventfiles/directory.json';
+
+const directory = await loadDirectory();
+const namesOfEvents: Record<string, string> = await generateMapping();
+
+async function watchForDirectoryChanges() {
+	const watcher = watch(DIRECTORY_FILE);
+	for await (const event of watcher) {
+		console.log(event);
+		if (event.eventType === 'change') {
+			await loadDirectory();
+			await generateMapping();
+		}
+	}
 }
 
-export async function count(): Promise<number> {
-	const allEvents = await getAll();
-	return allEvents.length;
+await watchForDirectoryChanges();
+
+async function loadDirectory(): Promise<Partial<EventDirectory>> {
+	const directoryString = await readFile(DIRECTORY_FILE);
+	const directory = JSON.parse(directoryString.toString()) as Partial<EventDirectory>;
+	return directory;
 }
 
-export async function exists(name: string): Promise<boolean> {
-	const allEvents = await getAll();
-	return allEvents.includes(name);
+async function generateMapping(): Promise<Record<string, string>> {
+	const namesOfEvents: Record<string, string> = {};
+
+	function collect(directory: Partial<EventDirectory>) {
+		for (const subDirectory of Object.values(directory.subDirectories ?? {})) {
+			collect(subDirectory);
+		}
+
+		Object.assign(namesOfEvents, directory.events ?? {});
+	}
+
+	collect(directory);
+
+	return namesOfEvents;
 }
 
-export async function nonExisting(names: readonly string[]): Promise<string[]> {
-	const allEvents = new Set(await getAll());
-	const result: string[] = [];
-	for (const event of names) {
-		if (!allEvents.has(event)) {
-			result.push(event);
+function resolvePath(path: string[]): Partial<EventDirectory> {
+	let resolvedDirectory = directory;
+
+	for (const part of path) {
+		if (resolvedDirectory.subDirectories === undefined || !(part in resolvedDirectory.subDirectories)) {
+			throw new Error('Ungültiger Pfad');
 		}
+
+		resolvedDirectory = resolvedDirectory.subDirectories[part]!;
 	}
 
-	return result;
+	return resolvedDirectory;
 }
 
-export async function find(
-	pattern: string | RegExp,
-	ignore: readonly string[] = [],
-): Promise<readonly string[]> {
-	const allEvents = await getAll();
-	const regex = new RegExp(pattern, 'i');
-	const filtered = allEvents.filter(event =>
-		regex.test(event) && !ignore.includes(event));
-	return filtered;
+export function getEventName(id: EventId): string {
+	return namesOfEvents[id] ?? id;
+}
+
+export function count(): number {
+	return Object.keys(namesOfEvents).length;
+}
+
+export function nonExisting(ids: readonly EventId[]): readonly EventId[] {
+	return ids.filter(id => !(id in namesOfEvents));
+}
+
+export function find(
+	pattern: string | RegExp | undefined,
+	startAt: string[] = [],
+): Readonly<EventDirectory> {
+	if (pattern !== undefined) {
+		const regex = new RegExp(pattern, 'i');
+		const accumulator: Events = {};
+
+		function collect(directory: Partial<EventDirectory>) {
+			for (const [eventId, name] of Object.entries(directory.events ?? {})) {
+				if (regex.test(name)) {
+					accumulator[eventId as EventId] = name;
+				}
+			}
+
+			for (const subDirectory of Object.values(directory.subDirectories ?? {})) {
+				collect(subDirectory);
+			}
+		}
+
+		collect(resolvePath(startAt));
+
+		return {
+			subDirectories: {},
+			events: Object.fromEntries(Object.entries(accumulator).sort((a, b) => a[1].localeCompare(b[1]))),
+		};
+	}
+
+	const directory = resolvePath(startAt);
+
+	return {
+		subDirectories: directory.subDirectories ?? {},
+		events: directory.events ?? {},
+	};
 }

source/lib/calendar-helper.ts

@@ -1,4 +1,4 @@
-import type {MyContext, Userconfig} from './types.ts';
+import type {EventId, MyContext, Userconfig} from './types.ts';
 
 export function getUrl(id: number, userconfig: Userconfig): string {
 	let filename = `${id}`;
@@ -14,3 +14,7 @@ export function getUrl(id: number, userconfig: Userconfig): string {
 export function getUrlFromContext(ctx: MyContext): string {
 	return getUrl(ctx.from!.id, ctx.userconfig.mine);
 }
+
+export function getUserEventIdsFromContext(ctx: MyContext): EventId[] {
+	return Object.keys(ctx.userconfig.mine.events) as EventId[];
+}

source/lib/change-helper.ts

@@ -1,6 +1,9 @@
 import {readFile} from 'node:fs/promises';
 import {html as format} from 'telegram-format';
-import type {Change, EventEntry, NaiveDateTime} from './types.ts';
+import type {
+	Change, EventEntry, EventId, NaiveDateTime,
+} from './types.ts';
+import {getEventName} from './all-events.js';
 
 export function generateChangeDescription(change: Change): string {
 	let text = '';
@@ -28,11 +31,11 @@ export function generateChangeDescription(change: Change): string {
 }
 
 export function generateChangeText(
-	name: string,
+	eventId: EventId,
 	date: NaiveDateTime | undefined,
 	change: Change,
 ): string {
-	let text = generateChangeTextHeader(name, date);
+	let text = generateChangeTextHeader(eventId, date);
 
 	if (Object.keys(change).length > 2) {
 		text += '\nÄnderungen:\n';
@@ -43,13 +46,13 @@ export function generateChangeText(
 }
 
 export function generateChangeTextHeader(
-	name: string,
+	eventId: EventId,
 	date: NaiveDateTime | undefined,
 ): string {
 	let text = '';
 	text += format.bold('Veranstaltungsänderung');
 	text += '\n';
-	text += format.bold(format.escape(name));
+	text += format.bold(format.escape(getEventName(eventId)));
 	if (date) {
 		text += ` ${date}`;
 	}
@@ -59,16 +62,15 @@ export function generateChangeTextHeader(
 }
 
 export function generateShortChangeText(
-	name: string,
+	eventId: EventId,
 	date: NaiveDateTime,
 ): string {
-	return `${name} ${date}`;
+	return `${getEventName(eventId)} ${date}`;
 }
 
-export async function loadEvents(eventname: string): Promise<EventEntry[]> {
+export async function loadEvents(eventId: EventId): Promise<EventEntry[]> {
 	try {
-		const filename = eventname.replaceAll('/', '-');
-		const content = await readFile(`eventfiles/${filename}.json`, 'utf8');
+		const content = await readFile(`eventfiles/${eventId}.json`, 'utf8');
 		return JSON.parse(content) as EventEntry[];
 	} catch (error) {
 		console.error('ERROR while loading events for change date picker', error);

source/lib/inline-menu-filter.ts

@@ -2,7 +2,7 @@ export const DEFAULT_FILTER = '.+';
 
 export function filterButtonText<T>(getCurrentFilterFunction: (ctx: T) => string | undefined): (ctx: T) => string {
 	return ctx => {
-		let text = '🔎 Filter';
+		let text = '🔎 Ab hier filtern';
 		const currentFilter = getCurrentFilterFunction(ctx);
 		if (currentFilter && currentFilter !== '.+') {
 			text += ': ' + currentFilter;

source/lib/types.ts

@@ -23,7 +23,9 @@ export type Session = {
 	adminuserquicklook?: number; // User ID
 	adminuserquicklookfilter?: string;
 	eventfilter?: string;
-	generateChangeName?: string;
+	eventPath?: string[]; // Path to the selected subdirectory
+	eventDirectorySubDirectoryItems?: string[]; // Subdirectory item keys of the directory selected by eventPath
+	generateChangeEventId?: EventId;
 	generateChangeDate?: NaiveDateTime;
 	generateChange?: Partial<Change>;
 	page?: number;
@@ -37,7 +39,7 @@ export type Session = {
 export type Userconfig = {
 	readonly admin?: true;
 	calendarfileSuffix: string;
-	events: Record<string, EventDetails>;
+	events: Record<EventId, EventDetails>;
 	mensa: MensaSettings;
 	removedEvents?: RemovedEventsDisplayStyle;
 };
@@ -82,6 +84,15 @@ export type MensaSettings = MealWishes & {
 	showAdditives?: boolean;
 };
 
+export type EventId = `${number}_${number | string}`;
+
+export type Events = Record<EventId, string>;
+
+export type EventDirectory = {
+	readonly subDirectories: Record<string, Partial<EventDirectory>>;
+	readonly events: Events;
+};
+
 export type EventEntry = {
 	readonly name: string;
 	readonly location: string;

source/menu/about.ts

@@ -10,7 +10,7 @@ export const menu = new MenuTemplate<MyContext>(async ctx => {
 
 	const canteens = await getCanteenList();
 	const canteenCount = canteens.length;
-	const eventCount = await allEvents.count();
+	const eventCount = allEvents.count();
 
 	const websiteLink = format.url(
 		'hawhh.de/calendarbot/',