@falkenslab/moodle-driver 0.0.0-stage → 0.3.1

package/dist/areas/courses/overview.d.ts

@@ -0,0 +1,83 @@
+import type { BrowserContext } from "playwright-core";
+/** One column of Moodle 5's activities overview, as `core_courseformat_get_overview_information` gives it. */
+interface OverviewItem {
+    key: string;
+    name: string;
+    contenttype: string;
+    alertlabel?: string;
+    alertcount?: string | number;
+    contentjson?: string | null;
+}
+/** A column's value, whatever exporter Moodle used for it, as text plus what it carries besides. */
+export interface OverviewField {
+    key: string;
+    label: string;
+    text: string;
+    date?: string;
+    url?: string;
+    details?: {
+        label: string;
+        value: string;
+    }[];
+    alert?: {
+        label: string;
+        count: number;
+    };
+}
+/** Reads one column: dates (humandate), plain values, dialogs with their lines, links and their alerts. */
+export declare function overviewField(item: OverviewItem): OverviewField;
+/**
+ * Moodle 5's activities overview of a course for one type ("resource" for every resource type):
+ * per activity, the columns its overview page shows the person (due dates, submissions, what needs
+ * grading, their own grade…). Without a type, every type in the course's state: "resource" first,
+ * which brings pages, books, files, folders and links at once, then each type still missing.
+ */
+export declare function activitiesOverview(context: BrowserContext, siteUrl: string, courseId: number, type?: string): Promise<{
+    fields: OverviewField[];
+    available?: boolean | undefined;
+    visible: boolean;
+    url?: string | undefined;
+    id: number;
+    name: string;
+    type: string;
+}[]>;
+/**
+ * What the person has to do by a date (calendar action events: submit, attempt, grade…), from the
+ * last `pastDays` to `days` ahead, in one course or all. Teachers' grading counts come from the
+ * activities overview instead: Moodle gives them few action events.
+ */
+export declare function deadlines(context: BrowserContext, siteUrl: string, { courseId, days, pastDays }?: {
+    courseId?: number;
+    days?: number;
+    pastDays?: number;
+}): Promise<{
+    action?: {
+        url?: string | undefined;
+        count?: number | undefined;
+        name: string;
+        actionable: boolean;
+    } | undefined;
+    course?: {
+        shortname?: string | undefined;
+        id: number;
+    } | undefined;
+    event: string;
+    kind: string;
+    date: string;
+    overdue: boolean;
+    type?: string | undefined;
+    activity: string;
+    activityId?: number | undefined;
+}[]>;
+/** What changed in a course's activities since a date, with their names from the course's state. */
+export declare function courseUpdates(context: BrowserContext, siteUrl: string, courseId: number, since: Date): Promise<{
+    changes: {
+        items?: number | undefined;
+        time?: string | undefined;
+        what: string;
+    }[];
+    name?: string | undefined;
+    type?: string | undefined;
+    id: number;
+}[]>;
+export {};

package/dist/areas/courses/overview.js

@@ -0,0 +1,137 @@
+import { callService } from "../../core/ajax.js";
+import { courseState } from "./state.js";
+import { decodeEntities } from "../../core/text.js";
+const plain = (html) => decodeEntities(html.replace(/<[^>]+>/g, " ")).replace(/\s+/g, " ").trim();
+/** Reads one column: dates (humandate), plain values, dialogs with their lines, links and their alerts. */
+export function overviewField(item) {
+    let data = {};
+    try {
+        data = JSON.parse(item.contentjson ?? "null") ?? {};
+    }
+    catch {
+        // An exporter Moodle may add later: the label alone.
+    }
+    const type = item.contenttype.split("\\").pop() ?? "";
+    const field = { key: item.key, label: decodeEntities(item.name), text: "" };
+    if (type === "humandate" && typeof data.timestamp === "number") {
+        field.date = new Date(data.timestamp * 1000).toISOString();
+        field.text = [data.date, data.time].filter(Boolean).join(" ");
+    }
+    else if (type === "pix_icon") {
+        // A mark (answered, submitted…): what it means is in its alt text.
+        const extras = data.extras ?? [];
+        field.text = decodeEntities(extras.find((e) => e.name === "alt")?.value ?? extras.find((e) => e.name === "title")?.value ?? "");
+    }
+    else if (type === "overviewdialog") {
+        field.text = plain(String(data.buttoncontent ?? ""));
+        const items = data.items ?? [];
+        if (items.length > 0)
+            field.details = items.map((i) => ({ label: plain(i.label), value: plain(String(i.value)) }));
+    }
+    else {
+        field.text = plain(String(data.content ?? data.value ?? ""));
+        if (typeof data.linkurl === "string")
+            field.url = data.linkurl;
+    }
+    if (item.alertlabel)
+        field.alert = { label: decodeEntities(item.alertlabel), count: Number(item.alertcount ?? 0) };
+    return field;
+}
+/**
+ * Moodle 5's activities overview of a course for one type ("resource" for every resource type):
+ * per activity, the columns its overview page shows the person (due dates, submissions, what needs
+ * grading, their own grade…). Without a type, every type in the course's state: "resource" first,
+ * which brings pages, books, files, folders and links at once, then each type still missing.
+ */
+export async function activitiesOverview(context, siteUrl, courseId, type) {
+    let types = type ? [type] : [];
+    let cmsByType = new Map();
+    if (!type) {
+        const state = await courseState(context, siteUrl, courseId);
+        cmsByType = new Map();
+        for (const cm of state.cm)
+            cmsByType.set(cm.module, [...(cmsByType.get(cm.module) ?? []), Number(cm.id)]);
+        types = ["resource", ...cmsByType.keys()];
+    }
+    const activities = [];
+    const seen = new Set();
+    for (const modname of types) {
+        // Every activity of this type came with an earlier answer ("resource").
+        if (!type && modname !== "resource" && (cmsByType.get(modname) ?? []).every((id) => seen.has(id)))
+            continue;
+        let answer;
+        try {
+            answer = await callService(context, siteUrl, "core_courseformat_get_overview_information", { courseid: courseId, modname });
+        }
+        catch (error) {
+            // A type without an overview (labels, some plugins) is left out when listing them all.
+            if (type)
+                throw error;
+            continue;
+        }
+        for (const activity of answer.activities) {
+            if (seen.has(activity.cmid))
+                continue;
+            seen.add(activity.cmid);
+            const name = activity.items.find((i) => i.key === "name");
+            const nameData = JSON.parse(name?.contentjson ?? "{}") ?? {};
+            activities.push({
+                id: activity.cmid,
+                name: decodeEntities(activity.name),
+                type: activity.modname,
+                ...(activity.url ? { url: activity.url } : {}),
+                visible: !nameData.hidden,
+                ...(nameData.available === false ? { available: false } : {}),
+                fields: activity.items.filter((i) => i.key !== "name").map(overviewField),
+            });
+        }
+    }
+    return activities;
+}
+/**
+ * What the person has to do by a date (calendar action events: submit, attempt, grade…), from the
+ * last `pastDays` to `days` ahead, in one course or all. Teachers' grading counts come from the
+ * activities overview instead: Moodle gives them few action events.
+ */
+export async function deadlines(context, siteUrl, { courseId, days = 30, pastDays = 7 } = {}) {
+    const now = Math.floor(Date.now() / 1000);
+    const window = { timesortfrom: now - pastDays * 86400, timesortto: now + days * 86400, limitnum: 50 };
+    const { events } = courseId
+        ? await callService(context, siteUrl, "core_calendar_get_action_events_by_course", { courseid: courseId, ...window })
+        : await callService(context, siteUrl, "core_calendar_get_action_events_by_timesort", window);
+    return events.map((event) => {
+        const activityId = event.url ? Number(new URL(event.url).searchParams.get("id")) || undefined : undefined;
+        return {
+            ...(activityId ? { activityId } : {}),
+            activity: decodeEntities(event.activityname ?? event.name),
+            ...(event.modulename ? { type: event.modulename } : {}),
+            event: decodeEntities(event.name),
+            kind: event.eventtype,
+            date: new Date(event.timesort * 1000).toISOString(),
+            overdue: event.overdue === true,
+            ...(event.course ? { course: { id: event.course.id, ...(event.course.shortname ? { shortname: decodeEntities(event.course.shortname) } : {}) } } : {}),
+            ...(event.action ? { action: { name: decodeEntities(event.action.name), actionable: event.action.actionable !== false, ...(event.action.itemcount ? { count: event.action.itemcount } : {}), ...(event.action.url ? { url: event.action.url } : {}) } } : {}),
+        };
+    });
+}
+/** What changed in a course's activities since a date, with their names from the course's state. */
+export async function courseUpdates(context, siteUrl, courseId, since) {
+    // One after the other: the first call may have to read the session's sesskey.
+    const { instances } = await callService(context, siteUrl, "core_course_get_updates_since", {
+        courseid: courseId,
+        since: Math.floor(since.getTime() / 1000),
+    });
+    const state = await courseState(context, siteUrl, courseId);
+    const byId = new Map(state.cm.map((cm) => [Number(cm.id), cm]));
+    return instances
+        .filter((instance) => instance.contextlevel === "module")
+        .map((instance) => {
+        const cm = byId.get(instance.id);
+        return {
+            id: instance.id,
+            ...(cm ? { name: decodeEntities(cm.name), type: cm.module } : {}),
+            changes: instance.updates.map((u) => ({ what: u.name, ...(u.timeupdated ? { time: new Date(u.timeupdated * 1000).toISOString() } : {}), ...(u.itemids ? { items: u.itemids.length } : {}) })),
+        };
+    });
+}
+//# sourceMappingURL=overview.js.map

package/dist/areas/courses/overview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overview.js","sourceRoot":"","sources":["../../../src/areas/courses/overview.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAgCpD,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AAE1G,2GAA2G;AAC3G,MAAM,UAAU,aAAa,CAAC,IAAkB;IAC9C,IAAI,IAAI,GAA4B,EAAE,CAAC;IACvC,IAAI,CAAC;QACH,IAAI,GAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,IAAI,MAAM,CAAoC,IAAI,EAAE,CAAC;IAC1F,CAAC;IAAC,MAAM,CAAC;QACP,qDAAqD;IACvD,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;IACtD,MAAM,KAAK,GAAkB,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAC3F,IAAI,IAAI,KAAK,WAAW,IAAI,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC/D,KAAK,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3D,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,CAAC;SAAM,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QAC/B,mEAAmE;QACnE,MAAM,MAAM,GAAI,IAAI,CAAC,MAAwD,IAAI,EAAE,CAAC;QACpF,KAAK,CAAC,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;IAClI,CAAC;SAAM,IAAI,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACrC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC;QACrD,MAAM,KAAK,GAAI,IAAI,CAAC,KAAwD,IAAI,EAAE,CAAC;QACnF,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrH,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ;YAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC;IACjE,CAAC;IACD,IAAI,IAAI,CAAC,UAAU;QAAE,KAAK,CAAC,KAAK,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC,EAAE,CAAC;IACnH,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,IAAa;IAChH,IAAI,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/B,IAAI,SAAS,GAAG,IAAI,GAAG,EAAoB,CAAC;IAC5C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QAC5D,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,EAAE;YAAE,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC1G,KAAK,GAAG,CAAC,UAAU,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE,CAAC;QAC5B,wEAAwE;QACxE,IAAI,CAAC,IAAI,IAAI,OAAO,KAAK,UAAU,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAAE,SAAS;QAC5G,IAAI,MAA0C,CAAC;QAC/C,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,4CAA4C,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAC9H,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,uFAAuF;YACvF,IAAI,IAAI;gBAAE,MAAM,KAAK,CAAC;YACtB,SAAS;QACX,CAAC;QACD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACzC,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAAE,SAAS;YACtC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,IAAI,IAAI,CAA+C,IAAI,EAAE,CAAC;YAC5G,UAAU,CAAC,IAAI,CAAC;gBACd,EAAE,EAAE,QAAQ,CAAC,IAAI;gBACjB,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACnC,IAAI,EAAE,QAAQ,CAAC,OAAO;gBACtB,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC9C,OAAO,EAAE,CAAC,QAAQ,CAAC,MAAM;gBACzB,GAAG,CAAC,QAAQ,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7D,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC;aAC1E,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAeD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAuB,EAAE,OAAe,EAAE,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,QAAQ,GAAG,CAAC,KAA8D,EAAE;IAC3K,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,EAAE,YAAY,EAAE,GAAG,GAAG,QAAQ,GAAG,KAAK,EAAE,UAAU,EAAE,GAAG,GAAG,IAAI,GAAG,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IACtG,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ;QACzB,CAAC,CAAC,MAAM,WAAW,CAA4B,OAAO,EAAE,OAAO,EAAE,2CAA2C,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;QAChJ,CAAC,CAAC,MAAM,WAAW,CAA4B,OAAO,EAAE,OAAO,EAAE,6CAA6C,EAAE,MAAM,CAAC,CAAC;IAC1H,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1G,OAAO;YACL,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,IAAI,CAAC;YAC1D,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC;YACjC,IAAI,EAAE,KAAK,CAAC,SAAS;YACrB,IAAI,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE;YACnD,OAAO,EAAE,KAAK,CAAC,OAAO,KAAK,IAAI;YAC/B,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACtJ,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,KAAK,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC9P,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,oGAAoG;AACpG,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,KAAW;IACzG,8EAA8E;IAC9E,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,WAAW,CAA+H,OAAO,EAAE,OAAO,EAAE,+BAA+B,EAAE;QACvN,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;KAC1C,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5D,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAChE,OAAO,SAAS;SACb,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,KAAK,QAAQ,CAAC;SACxD,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChB,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACjC,OAAO;YACL,EAAE,EAAE,QAAQ,CAAC,EAAE;YACf,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACjE,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;SAC9L,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/areas/courses/state.d.ts

@@ -0,0 +1,51 @@
+import type { BrowserContext, Page } from "playwright-core";
+/** `core_courseformat_get_state` as Moodle 4.0–5.2 returns it, the fields read. */
+export interface CourseState {
+    course?: {
+        id: string;
+        baseurl?: string;
+    };
+    section: {
+        id: string;
+        number: number;
+        title: string;
+        visible?: boolean;
+        hasrestrictions?: boolean;
+        sectionurl?: string;
+        component?: string | null;
+        parentsectionid?: string | null;
+        cmlist?: string[];
+    }[];
+    cm: {
+        id: string;
+        name: string;
+        module: string;
+        url?: string;
+        visible: boolean;
+        uservisible?: boolean;
+        accessvisible?: boolean;
+        hascmrestrictions?: boolean;
+        sectionid: string;
+        istrackeduser?: boolean;
+        completionstate?: number;
+        isoverallcomplete?: boolean;
+    }[];
+}
+/** The course page's own state: sections and activities, as a JSON string (ADR-004). */
+export declare function courseState(context: BrowserContext, siteUrl: string, courseId: number): Promise<CourseState>;
+/** What the course page shows of an activity, in the site's language. */
+export interface ActivityDetails {
+    id: number;
+    dates: {
+        label: string;
+        value: string;
+    }[];
+    restriction?: string;
+}
+/** The activities on a course or section page: their dates and restriction texts. */
+export declare function readActivityDetails(page: Page): Promise<ActivityDetails[]>;
+/**
+ * Details for the given activities: from the course page, then from the section pages of those it
+ * doesn't show (courses with one section per page).
+ */
+export declare function activityDetails(context: BrowserContext, siteUrl: string, courseId: number, state: CourseState): Promise<Map<number, ActivityDetails>>;

package/dist/areas/courses/state.js

@@ -0,0 +1,45 @@
+import { callService } from "../../core/ajax.js";
+import { openSitePage } from "../../core/session.js";
+/** The course page's own state: sections and activities, as a JSON string (ADR-004). */
+export async function courseState(context, siteUrl, courseId) {
+    return JSON.parse(await callService(context, siteUrl, "core_courseformat_get_state", { courseid: courseId }));
+}
+/** The activities on a course or section page: their dates and restriction texts. */
+export function readActivityDetails(page) {
+    return page.evaluate(() => {
+        const doc = globalThis.document;
+        // No helper functions in here: see the conventions on page.evaluate.
+        return Array.from(doc.querySelectorAll('[data-for="cmitem"][data-id], li.activity[data-id]')).map((item) => {
+            const dates = Array.from(item.querySelectorAll('[data-region="activity-dates"] .date-item')).map((date) => {
+                const label = (date.querySelector(".date-item-label")?.textContent ?? "").replace(/\s+/g, " ").trim();
+                const all = (date.textContent ?? "").replace(/\s+/g, " ").trim();
+                return { label: label.replace(/:$/, ""), value: all.slice(label.length).trim() };
+            });
+            const restriction = (item.querySelector(".availabilityinfo")?.textContent ?? "").replace(/\s+/g, " ").trim() || undefined;
+            return { id: Number(item.getAttribute("data-id")), dates, restriction };
+        });
+    });
+}
+/**
+ * Details for the given activities: from the course page, then from the section pages of those it
+ * doesn't show (courses with one section per page).
+ */
+export async function activityDetails(context, siteUrl, courseId, state) {
+    const details = new Map();
+    const read = async (path) => {
+        const page = await openSitePage(context, siteUrl, path);
+        try {
+            for (const item of await readActivityDetails(page))
+                details.set(item.id, item);
+        }
+        finally {
+            await page.close().catch(() => undefined);
+        }
+    };
+    await read(`course/view.php?id=${courseId}`);
+    const missingSections = new Set(state.cm.filter((cm) => !details.has(Number(cm.id))).map((cm) => cm.sectionid));
+    for (const sectionId of missingSections)
+        await read(`course/section.php?id=${sectionId}`);
+    return details;
+}
+//# sourceMappingURL=state.js.map

package/dist/areas/courses/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../../../src/areas/courses/state.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAgCrD,wFAAwF;AACxF,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB;IAC1F,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,WAAW,CAAS,OAAO,EAAE,OAAO,EAAE,6BAA6B,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAgB,CAAC;AACvI,CAAC;AASD,qFAAqF;AACrF,MAAM,UAAU,mBAAmB,CAAC,IAAU;IAC5C,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;QAOxB,MAAM,GAAG,GAAI,UAA+C,CAAC,QAAQ,CAAC;QACtE,qEAAqE;QACrE,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,oDAAoD,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACzG,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,2CAA2C,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACxG,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;gBACtG,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;gBACjE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YACnF,CAAC,CAAC,CAAC;YACH,MAAM,WAAW,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,SAAS,CAAC;YAC1H,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;QAC1E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,KAAkB;IAClH,MAAM,OAAO,GAAG,IAAI,GAAG,EAA2B,CAAC;IACnD,MAAM,IAAI,GAAG,KAAK,EAAE,IAAY,EAAE,EAAE;QAClC,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC;YACH,KAAK,MAAM,IAAI,IAAI,MAAM,mBAAmB,CAAC,IAAI,CAAC;gBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACjF,CAAC;gBAAS,CAAC;YACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC,CAAC;IACF,MAAM,IAAI,CAAC,sBAAsB,QAAQ,EAAE,CAAC,CAAC;IAC7C,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAChH,KAAK,MAAM,SAAS,IAAI,eAAe;QAAE,MAAM,IAAI,CAAC,yBAAyB,SAAS,EAAE,CAAC,CAAC;IAC1F,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/areas/courses/structure.d.ts

@@ -0,0 +1,89 @@
+import type { BrowserContext } from "playwright-core";
+import { type ActivityDetails, type CourseState } from "./state.js";
+/** Moodle's completion states (COMPLETION_INCOMPLETE … COMPLETION_COMPLETE_FAIL), by their value. */
+export declare const COMPLETION_STATES: readonly ["incomplete", "complete", "complete-pass", "complete-fail"];
+export type CompletionState = (typeof COMPLETION_STATES)[number];
+export interface CourseActivity {
+    /** The course module id, which every activity function takes. */
+    id: number;
+    name: string;
+    /** The module: "page", "assign", "quiz", "forum", "resource"… */
+    type: string;
+    url?: string;
+    /** Shown to students. */
+    visible: boolean;
+    /** The person can open it now. */
+    availableToMe: boolean;
+    restricted: boolean;
+    /** The person's completion, when the activity tracks it for them. */
+    completion?: {
+        state: CompletionState;
+        complete: boolean;
+    };
+    /** With details: as the course page shows them, in the site's language. */
+    dates?: {
+        label: string;
+        value: string;
+    }[];
+    /** With details: the restriction as the course page shows it. */
+    restriction?: string;
+}
+export interface CourseSection {
+    id: number;
+    number: number;
+    title: string;
+    visible: boolean;
+    restricted: boolean;
+    url?: string;
+    /** For a subsection, the section that holds it. */
+    parentSectionId?: number;
+    activities: CourseActivity[];
+}
+/** The state as sections with their activities, in the course's order; details merged when given. */
+export declare function structureOf(state: CourseState, details?: Map<number, ActivityDetails>): CourseSection[];
+/** A course's sections and activities; with `details`, each activity's dates and restriction from the course page (slower). */
+export declare function courseStructure(context: BrowserContext, siteUrl: string, courseId: number, { details }?: {
+    details?: boolean | undefined;
+}): Promise<CourseSection[]>;
+export interface CourseAssignment {
+    /** The assignment's course module id. */
+    id: number;
+    name: string;
+    url: string;
+    visible: boolean;
+    section: {
+        number: number;
+        title: string;
+    };
+}
+/** The course's assignments, in the course's order. */
+export declare function assignmentsOf(state: CourseState): CourseAssignment[];
+/** The course's assignments, in the course's order, with the section each is in. */
+export declare function listAssignments(context: BrowserContext, siteUrl: string, courseId: number): Promise<CourseAssignment[]>;
+export interface PendingActivity {
+    activityId: number;
+    name: string;
+    type: string;
+    url?: string;
+    section: {
+        number: number;
+        title: string;
+    };
+    /** Tracked and not complete, or (completion not tracked) graded and not graded yet. */
+    reason: "incomplete" | "not-graded";
+    completion?: string;
+    availableToMe: boolean;
+    dates?: {
+        label: string;
+        value: string;
+    }[];
+    restriction?: string;
+}
+/**
+ * What the person still has to do in a course: activities whose completion is tracked and not
+ * complete or, where completion isn't tracked, graded activities without a grade yet.
+ */
+export declare function pendingActivities(context: BrowserContext, siteUrl: string, courseId: number): Promise<{
+    completionTracked: boolean;
+    pending: PendingActivity[];
+}>;

package/dist/areas/courses/structure.js

@@ -0,0 +1,104 @@
+import { activityDetails, courseState } from "./state.js";
+import { myGrades } from "../grades/user-report.js";
+import { decodeEntities } from "../../core/text.js";
+/** Moodle's completion states (COMPLETION_INCOMPLETE … COMPLETION_COMPLETE_FAIL), by their value. */
+export const COMPLETION_STATES = ["incomplete", "complete", "complete-pass", "complete-fail"];
+/** The state as sections with their activities, in the course's order; details merged when given. */
+export function structureOf(state, details) {
+    const cms = new Map(state.cm.map((cm) => [cm.id, cm]));
+    return state.section.map((s) => {
+        const ids = s.cmlist ?? state.cm.filter((cm) => cm.sectionid === s.id).map((cm) => cm.id);
+        const activities = ids.flatMap((id) => {
+            const cm = cms.get(id);
+            if (!cm)
+                return [];
+            const extra = details?.get(Number(cm.id));
+            const state = cm.istrackeduser && cm.completionstate !== undefined ? COMPLETION_STATES[cm.completionstate] : undefined;
+            return [
+                {
+                    id: Number(cm.id),
+                    name: decodeEntities(cm.name),
+                    type: cm.module,
+                    url: cm.url,
+                    visible: cm.visible,
+                    availableToMe: (cm.uservisible ?? true) && (cm.accessvisible ?? true),
+                    restricted: cm.hascmrestrictions ?? false,
+                    completion: state ? { state, complete: cm.isoverallcomplete ?? state !== "incomplete" } : undefined,
+                    dates: extra && extra.dates.length > 0 ? extra.dates : undefined,
+                    restriction: extra?.restriction,
+                },
+            ];
+        });
+        return {
+            id: Number(s.id),
+            number: s.number,
+            title: decodeEntities(s.title),
+            visible: s.visible ?? true,
+            restricted: s.hasrestrictions ?? false,
+            url: s.sectionurl,
+            parentSectionId: s.parentsectionid ? Number(s.parentsectionid) : undefined,
+            activities,
+        };
+    });
+}
+/** A course's sections and activities; with `details`, each activity's dates and restriction from the course page (slower). */
+export async function courseStructure(context, siteUrl, courseId, { details = false } = {}) {
+    const state = await courseState(context, siteUrl, courseId);
+    const extra = details ? await activityDetails(context, siteUrl, courseId, state) : undefined;
+    return structureOf(state, extra);
+}
+/** The course's assignments, in the course's order. */
+export function assignmentsOf(state) {
+    const sections = new Map(state.section.map((section) => [section.id, section]));
+    return state.cm
+        .filter((cm) => cm.module === "assign")
+        .map((cm) => {
+        const section = sections.get(cm.sectionid);
+        return {
+            id: Number(cm.id),
+            name: decodeEntities(cm.name),
+            url: cm.url ?? "",
+            visible: cm.visible,
+            section: { number: section?.number ?? 0, title: decodeEntities(section?.title ?? "") },
+        };
+    });
+}
+/** The course's assignments, in the course's order, with the section each is in. */
+export async function listAssignments(context, siteUrl, courseId) {
+    return assignmentsOf(await courseState(context, siteUrl, courseId));
+}
+/**
+ * What the person still has to do in a course: activities whose completion is tracked and not
+ * complete or, where completion isn't tracked, graded activities without a grade yet.
+ */
+export async function pendingActivities(context, siteUrl, courseId) {
+    const state = await courseState(context, siteUrl, courseId);
+    const sections = structureOf(state, await activityDetails(context, siteUrl, courseId, state));
+    const ungraded = new Set((await myGrades(context, siteUrl, courseId).catch(() => [])).filter((row) => row.kind === "item" && row.activityId && !row.grade).map((row) => row.activityId));
+    const completionTracked = state.cm.some((cm) => cm.istrackeduser && cm.completionstate !== undefined);
+    const pending = [];
+    for (const section of sections) {
+        for (const activity of section.activities) {
+            if (!activity.visible && !activity.availableToMe)
+                continue;
+            const tracked = activity.completion !== undefined;
+            const reason = tracked ? (activity.completion.complete ? undefined : "incomplete") : ungraded.has(activity.id) ? "not-graded" : undefined;
+            if (!reason)
+                continue;
+            pending.push({
+                activityId: activity.id,
+                name: activity.name,
+                type: activity.type,
+                url: activity.url,
+                section: { number: section.number, title: section.title },
+                reason,
+                completion: activity.completion?.state,
+                availableToMe: activity.availableToMe,
+                dates: activity.dates,
+                restriction: activity.restriction,
+            });
+        }
+    }
+    return { completionTracked, pending };
+}
+//# sourceMappingURL=structure.js.map

package/dist/areas/courses/structure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"structure.js","sourceRoot":"","sources":["../../../src/areas/courses/structure.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,WAAW,EAA0C,MAAM,YAAY,CAAC;AAClG,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,qGAAqG;AACrG,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,CAAU,CAAC;AAmCvG,qGAAqG;AACrG,MAAM,UAAU,WAAW,CAAC,KAAkB,EAAE,OAAsC;IACpF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACvD,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC7B,MAAM,GAAG,GAAG,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAC1F,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;YACpC,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACvB,IAAI,CAAC,EAAE;gBAAE,OAAO,EAAE,CAAC;YACnB,MAAM,KAAK,GAAG,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,EAAE,CAAC,aAAa,IAAI,EAAE,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACvH,OAAO;gBACL;oBACE,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;oBACjB,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC;oBAC7B,IAAI,EAAE,EAAE,CAAC,MAAM;oBACf,GAAG,EAAE,EAAE,CAAC,GAAG;oBACX,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,aAAa,EAAE,CAAC,EAAE,CAAC,WAAW,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,IAAI,IAAI,CAAC;oBACrE,UAAU,EAAE,EAAE,CAAC,iBAAiB,IAAI,KAAK;oBACzC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,iBAAiB,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC,CAAC,CAAC,SAAS;oBACnG,KAAK,EAAE,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;oBAChE,WAAW,EAAE,KAAK,EAAE,WAAW;iBAChC;aACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO;YACL,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YAChB,MAAM,EAAE,CAAC,CAAC,MAAM;YAChB,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC;YAC9B,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,IAAI;YAC1B,UAAU,EAAE,CAAC,CAAC,eAAe,IAAI,KAAK;YACtC,GAAG,EAAE,CAAC,CAAC,UAAU;YACjB,eAAe,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS;YAC1E,UAAU;SACX,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,+HAA+H;AAC/H,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,EAAE,OAAO,GAAG,KAAK,EAAE,GAAG,EAAE;IACxH,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7F,OAAO,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AACnC,CAAC;AAWD,uDAAuD;AACvD,MAAM,UAAU,aAAa,CAAC,KAAkB;IAC9C,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAChF,OAAO,KAAK,CAAC,EAAE;SACZ,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,MAAM,KAAK,QAAQ,CAAC;SACtC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;QACV,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;QAC3C,OAAO;YACL,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;YACjB,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC;YAC7B,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE;YACjB,OAAO,EAAE,EAAE,CAAC,OAAO;YACnB,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,EAAE;SACvF,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC;AAED,oFAAoF;AACpF,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB;IAC9F,OAAO,aAAa,CAAC,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;AACtE,CAAC;AAgBD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB;IAChG,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5D,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,EAAE,MAAM,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;IAC9F,MAAM,QAAQ,GAAG,IAAI,GAAG,CACtB,CAAC,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,UAAU,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAC/J,CAAC;IACF,MAAM,iBAAiB,GAAG,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,aAAa,IAAI,EAAE,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC;IACtG,MAAM,OAAO,GAAsB,EAAE,CAAC;IACtC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YAC1C,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa;gBAAE,SAAS;YAC3D,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,KAAK,SAAS,CAAC;YAClD,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3I,IAAI,CAAC,MAAM;gBAAE,SAAS;YACtB,OAAO,CAAC,IAAI,CAAC;gBACX,UAAU,EAAE,QAAQ,CAAC,EAAE;gBACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,GAAG,EAAE,QAAQ,CAAC,GAAG;gBACjB,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE;gBACzD,MAAM;gBACN,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,KAAK;gBACtC,aAAa,EAAE,QAAQ,CAAC,aAAa;gBACrC,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,WAAW,EAAE,QAAQ,CAAC,WAAW;aAClC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,CAAC;AACxC,CAAC"}

package/dist/areas/forums/discussions.d.ts

@@ -0,0 +1,57 @@
+import type { BrowserContext, Page } from "playwright-core";
+import { MoodleError } from "../../core/errors.js";
+/** The id isn't a forum's course module, or the person can't see it. */
+export declare class NotAForumError extends MoodleError {
+    name: string;
+    constructor(message: string);
+}
+/** A discussion as the forum page lists it. */
+export interface DiscussionRow {
+    id: number;
+    subject: string;
+    author: string;
+    started?: number;
+    lastPost: {
+        author: string;
+        time?: number;
+        postId?: number;
+    };
+    replies: number;
+    locked: boolean;
+    pinned: boolean;
+    /** The forum's instance id, which the forum's services take. */
+    forumInstanceId?: number;
+}
+/** The discussions on a forum page, read by structure: data attributes, links, timestamps. */
+export declare function readDiscussionRows(page: Page): Promise<DiscussionRow[]>;
+/** Every discussion of a forum (its course module id), through all its pages. */
+export declare function listDiscussions(context: BrowserContext, siteUrl: string, activityId: number): Promise<DiscussionRow[]>;
+/** A post as `mod_forum_get_discussion_posts` returns it (Moodle 5.2), the fields read. */
+export interface MoodlePost {
+    id: number;
+    subject: string;
+    message: string;
+    author: {
+        id: number;
+        fullname: string;
+    };
+    parentid: number | null;
+    timecreated: number;
+    timemodified?: number;
+    isprivatereply?: boolean;
+    unread?: boolean | null;
+    attachments?: {
+        filename: string;
+        url?: string;
+        fileurl?: string;
+    }[];
+}
+export declare function discussionPosts(context: BrowserContext, siteUrl: string, discussionId: number): Promise<{
+    posts: MoodlePost[];
+    forumid: number;
+    courseid: number;
+}>;
+/** Plain text of Moodle-cleaned HTML fragments, parsed in a blank tab. */
+export declare function htmlToTexts(context: BrowserContext, fragments: string[]): Promise<string[]>;
+/** A forum's instance id (what `post.php?forum=` takes), from its page. */
+export declare function forumInstanceId(context: BrowserContext, siteUrl: string, activityId: number): Promise<number>;