@falkenslab/moodle-driver 0.0.0-stage → 0.3.1

package/dist/areas/assignments/student.d.ts

@@ -0,0 +1,57 @@
+import type { BrowserContext, Page } from "playwright-core";
+import { MoodleError } from "../../core/errors.js";
+/** The assignment isn't there, or the person can't do that now. */
+export declare class SubmissionError extends MoodleError {
+    name: string;
+    constructor(message: string);
+}
+/** An assignment as the student's page shows it. */
+export interface StudentAssignment {
+    description: string;
+    descriptionFiles: {
+        name: string;
+        url: string;
+    }[];
+    dates: {
+        label: string;
+        value: string;
+    }[];
+    status: {
+        label: string;
+        value: string;
+    }[];
+    submissionState?: string;
+    graded: boolean;
+    submittedFiles: {
+        name: string;
+        url: string;
+    }[];
+    feedback: {
+        label: string;
+        value: string;
+    }[];
+    canEdit: boolean;
+    canSubmit: boolean;
+}
+export declare function readStudentAssignment(page: Page): Promise<StudentAssignment>;
+/** An assignment as the student sees it: its description and files, dates, the submission's status and files, the feedback, and whether it can be edited or submitted now. */
+export declare function studentAssignment(context: BrowserContext, siteUrl: string, activityId: number): Promise<StudentAssignment>;
+/** Saves the submission's online text and adds files, as "Save changes" on the edit page does; gives the assignment afterwards. */
+export declare function saveSubmission(context: BrowserContext, siteUrl: string, activityId: number, input: {
+    onlineText?: string;
+    files?: string[];
+}): Promise<{
+    changed: string;
+    assignment: StudentAssignment;
+}>;
+/**
+ * Submits the saved submission for grading, accepting the site's statement when it asks for one
+ * (`acceptStatement`, once the person agrees; a bare boolean as before 0.2 too); gives the
+ * assignment afterwards.
+ */
+export declare function submitForGrading(context: BrowserContext, siteUrl: string, activityId: number, options?: {
+    acceptStatement?: boolean;
+} | boolean): Promise<{
+    changed: string;
+    assignment: StudentAssignment;
+}>;

package/dist/areas/assignments/student.js

@@ -0,0 +1,115 @@
+import { checkLocalFiles } from "../../core/files.js";
+import { formValue, openForm, setFields, submitForm, uploadToDraft } from "../../core/forms.js";
+import { inPage } from "../../core/inPage.js";
+import { NotLoggedInError, openSitePage } from "../../core/session.js";
+import { MoodleError } from "../../core/errors.js";
+/** The assignment isn't there, or the person can't do that now. */
+export class SubmissionError extends MoodleError {
+    name = "SubmissionError";
+    constructor(message) {
+        super(message, "submission");
+    }
+}
+export function readStudentAssignment(page) {
+    return inPage(page, () => {
+        const doc = globalThis.document;
+        const text = (el) => (el?.innerText ?? "")
+            .replace(/[ \t]+/g, " ")
+            .replace(/\n{3,}/g, "\n\n")
+            .trim();
+        const links = (selector) => Array.from(doc.querySelectorAll(selector)).map((a) => ({ name: text(a), url: a.href }));
+        const rows = (selector) => Array.from(doc.querySelectorAll(selector)).map((row) => ({ label: text(row.querySelector("th")), value: text(row.querySelector("td")) }));
+        const stateCell = Array.from(doc.querySelectorAll(".submissionstatustable td")).find((td) => /\bsubmissionstatus[a-z]+\b/.test(td.className));
+        const actions = Array.from(doc.querySelectorAll('form input[name="action"]')).map((input) => input.value);
+        return {
+            description: text(doc.querySelector(".activity-description, #intro")),
+            descriptionFiles: links('.activity-description a[href*="pluginfile.php"], #intro a[href*="pluginfile.php"]'),
+            dates: Array.from(doc.querySelectorAll('[data-region="activity-dates"] .date-item')).map((item) => {
+                const label = text(item.querySelector(".date-item-label"));
+                return { label: label.replace(/:$/, ""), value: text(item).slice(label.length).trim() };
+            }),
+            status: rows(".submissionstatustable tr"),
+            submissionState: stateCell ? /\bsubmissionstatus([a-z]+)\b/.exec(stateCell.className)?.[1] : undefined,
+            graded: doc.querySelector(".submissionstatustable td.submissiongraded") !== null,
+            submittedFiles: links('.submissionstatustable a[href*="pluginfile.php"]'),
+            feedback: rows(".feedback tr"),
+            canEdit: actions.includes("editsubmission"),
+            canSubmit: actions.includes("submit"),
+        };
+    }, null);
+}
+/** An assignment as the student sees it: its description and files, dates, the submission's status and files, the feedback, and whether it can be edited or submitted now. */
+export async function studentAssignment(context, siteUrl, activityId) {
+    const page = await openSitePage(context, siteUrl, `mod/assign/view.php?id=${activityId}`);
+    try {
+        if ((await page.locator("body#page-mod-assign-view").count()) === 0) {
+            throw new SubmissionError(`Activity ${activityId} isn't an assignment you can open. Take the id of an assignment (module "assign") from the course structure.`);
+        }
+        return await readStudentAssignment(page);
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+}
+/** Saves the submission's online text and adds files, as "Save changes" on the edit page does; gives the assignment afterwards. */
+export async function saveSubmission(context, siteUrl, activityId, input) {
+    if (input.onlineText === undefined && (!input.files || input.files.length === 0))
+        throw new SubmissionError("Give online text, files or both.");
+    if (input.files)
+        await checkLocalFiles(input.files);
+    const page = await openForm(context, siteUrl, `mod/assign/view.php?id=${activityId}&action=editsubmission`).catch((error) => {
+        if (error instanceof NotLoggedInError)
+            throw error;
+        throw new SubmissionError(`You can't edit a submission to assignment ${activityId} now (submitted already, past its cut-off date, or not yours to submit).`);
+    });
+    try {
+        if (input.files && input.files.length > 0) {
+            const draft = await formValue(page, "files_filemanager");
+            if (!draft)
+                throw new SubmissionError(`Assignment ${activityId} doesn't take file submissions.`);
+            await uploadToDraft(page, draft, input.files);
+        }
+        const values = {};
+        if (input.onlineText !== undefined) {
+            if ((await formValue(page, "onlinetext_editor[format]")) === undefined)
+                throw new SubmissionError(`Assignment ${activityId} doesn't take online text.`);
+            values["onlinetext_editor[text]"] = input.onlineText;
+        }
+        await setFields(page, values);
+        await submitForm(page, "submitbutton");
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+    const saved = [input.onlineText !== undefined ? "online text" : "", input.files?.length ? `${input.files.length} file${input.files.length === 1 ? "" : "s"}` : ""].filter(Boolean).join(" and ");
+    return { changed: `Saved ${saved} in assignment ${activityId}'s submission.`, assignment: await studentAssignment(context, siteUrl, activityId) };
+}
+/**
+ * Submits the saved submission for grading, accepting the site's statement when it asks for one
+ * (`acceptStatement`, once the person agrees; a bare boolean as before 0.2 too); gives the
+ * assignment afterwards.
+ */
+export async function submitForGrading(context, siteUrl, activityId, options = {}) {
+    const acceptStatement = typeof options === "boolean" ? options : (options.acceptStatement ?? false);
+    const page = await openForm(context, siteUrl, `mod/assign/view.php?id=${activityId}&action=submit`).catch((error) => {
+        if (error instanceof NotLoggedInError)
+            throw error;
+        throw new SubmissionError(`Assignment ${activityId} has nothing to submit now (no draft, submitted already, or it doesn't ask students to click submit).`);
+    });
+    try {
+        const statement = page.locator('form.mform [name="submissionstatement"][type="checkbox"]');
+        if ((await statement.count()) > 0) {
+            if (!acceptStatement) {
+                const text = await statement.first().evaluate((box) => box.closest(".form-check, .fitem")?.textContent ?? "");
+                throw new SubmissionError(`Submitting asks to accept this statement; call again with acceptStatement once the person agrees: ${text.replace(/\s+/g, " ").trim()}`);
+            }
+            await setFields(page, { submissionstatement: true });
+        }
+        await submitForm(page, "submitbutton");
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+    return { changed: `Submitted assignment ${activityId} for grading.`, assignment: await studentAssignment(context, siteUrl, activityId) };
+}
+//# sourceMappingURL=student.js.map

package/dist/areas/assignments/student.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"student.js","sourceRoot":"","sources":["../../../src/areas/assignments/student.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAmB,MAAM,qBAAqB,CAAC;AACjH,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,mEAAmE;AACnE,MAAM,OAAO,eAAgB,SAAQ,WAAW;IACrC,IAAI,GAAG,iBAAiB,CAAC;IAClC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC/B,CAAC;CACF;AAgBD,MAAM,UAAU,qBAAqB,CAAC,IAAU;IAC9C,OAAO,MAAM,CACX,IAAI,EACJ,GAAG,EAAE;QASH,MAAM,GAAG,GAAI,UAA0C,CAAC,QAAQ,CAAC;QACjE,MAAM,IAAI,GAAG,CAAC,EAAyB,EAAE,EAAE,CACzC,CAAC,EAAE,EAAE,SAAS,IAAI,EAAE,CAAC;aAClB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;aACvB,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC;aAC1B,IAAI,EAAE,CAAC;QACZ,MAAM,KAAK,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC5H,MAAM,IAAI,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7K,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,2BAA2B,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,4BAA4B,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QAC9I,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,2BAA2B,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1G,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,+BAA+B,CAAC,CAAC;YACrE,gBAAgB,EAAE,KAAK,CAAC,mFAAmF,CAAC;YAC5G,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,2CAA2C,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChG,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC;gBAC3D,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YAC1F,CAAC,CAAC;YACF,MAAM,EAAE,IAAI,CAAC,2BAA2B,CAAC;YACzC,eAAe,EAAE,SAAS,CAAC,CAAC,CAAC,8BAA8B,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;YACtG,MAAM,EAAE,GAAG,CAAC,aAAa,CAAC,4CAA4C,CAAC,KAAK,IAAI;YAChF,cAAc,EAAE,KAAK,CAAC,kDAAkD,CAAC;YACzE,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC;YAC9B,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YAC3C,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;SACtC,CAAC;IACJ,CAAC,EACD,IAAI,CACL,CAAC;AACJ,CAAC;AAED,8KAA8K;AAC9K,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,OAAuB,EAAE,OAAe,EAAE,UAAkB;IAClG,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,0BAA0B,UAAU,EAAE,CAAC,CAAC;IAC1F,IAAI,CAAC;QACH,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;YACpE,MAAM,IAAI,eAAe,CAAC,YAAY,UAAU,8GAA8G,CAAC,CAAC;QAClK,CAAC;QACD,OAAO,MAAM,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED,mIAAmI;AACnI,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAAuB,EACvB,OAAe,EACf,UAAkB,EAClB,KAAgD;IAEhD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;QAAE,MAAM,IAAI,eAAe,CAAC,kCAAkC,CAAC,CAAC;IAChJ,IAAI,KAAK,CAAC,KAAK;QAAE,MAAM,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,0BAA0B,UAAU,wBAAwB,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACnI,IAAI,KAAK,YAAY,gBAAgB;YAAE,MAAM,KAAK,CAAC;QACnD,MAAM,IAAI,eAAe,CAAC,6CAA6C,UAAU,0EAA0E,CAAC,CAAC;IAC/J,CAAC,CAAC,CAAC;IACH,IAAI,CAAC;QACH,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1C,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;YACzD,IAAI,CAAC,KAAK;gBAAE,MAAM,IAAI,eAAe,CAAC,cAAc,UAAU,iCAAiC,CAAC,CAAC;YACjG,MAAM,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;QACD,MAAM,MAAM,GAA+B,EAAE,CAAC;QAC9C,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,SAAS,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAC,KAAK,SAAS;gBAAE,MAAM,IAAI,eAAe,CAAC,cAAc,UAAU,4BAA4B,CAAC,CAAC;YACxJ,MAAM,CAAC,yBAAyB,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC;QACvD,CAAC;QACD,MAAM,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9B,MAAM,UAAU,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACzC,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,QAAQ,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjM,OAAO,EAAE,OAAO,EAAE,SAAS,KAAK,kBAAkB,UAAU,gBAAgB,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;AACpJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAuB,EACvB,OAAe,EACf,UAAkB,EAClB,UAAmD,EAAE;IAErD,MAAM,eAAe,GAAG,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,IAAI,KAAK,CAAC,CAAC;IACpG,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,0BAA0B,UAAU,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QAC3H,IAAI,KAAK,YAAY,gBAAgB;YAAE,MAAM,KAAK,CAAC;QACnD,MAAM,IAAI,eAAe,CAAC,cAAc,UAAU,uGAAuG,CAAC,CAAC;IAC7J,CAAC,CAAC,CAAC;IACH,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,0DAA0D,CAAC,CAAC;QAC3F,IAAI,CAAC,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,EAAE,CAAE,GAAgF,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC;gBAC5L,MAAM,IAAI,eAAe,CAAC,qGAAqG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACrK,CAAC;YACD,MAAM,SAAS,CAAC,IAAI,EAAE,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,UAAU,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACzC,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,wBAAwB,UAAU,eAAe,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;AAC3I,CAAC"}

package/dist/areas/calendar/calendar.d.ts

@@ -0,0 +1,43 @@
+import type { BrowserContext } from "playwright-core";
+import { MoodleError } from "../../core/errors.js";
+/** Moodle refused the event, or it isn't there. */
+export declare class CalendarError extends MoodleError {
+    name: string;
+    constructor(message: string);
+}
+export interface CalendarEvent {
+    id: number;
+    name: string;
+    /** The event's kind: "course", "group", "user", or an activity's ("due", "open"…). */
+    type: string;
+    start: string;
+    durationMinutes?: number;
+    courseId?: number;
+    /** For an activity's event, its module and instance. */
+    activity?: {
+        type: string;
+        instance: number;
+    };
+}
+/** The person's upcoming events, as the calendar's "Upcoming events" view lists them, in one course or all. */
+export declare function upcomingEvents(context: BrowserContext, siteUrl: string, { courseId }?: {
+    courseId?: number;
+}): Promise<CalendarEvent[]>;
+/**
+ * Creates a course event, through the calendar's own form: its start, and its duration and
+ * description when given. Returns it as the calendar has it.
+ */
+export declare function createEvent(context: BrowserContext, siteUrl: string, { courseId, name, start, durationMinutes, description }: {
+    courseId: number;
+    name: string;
+    start: Date;
+    durationMinutes?: number;
+    description?: string;
+}): Promise<{
+    changed: string;
+    event: CalendarEvent;
+}>;
+/** Deletes a calendar event the person can manage. */
+export declare function deleteEvent(context: BrowserContext, siteUrl: string, eventId: number): Promise<{
+    changed: string;
+}>;

package/dist/areas/calendar/calendar.js

@@ -0,0 +1,84 @@
+import { MoodleServiceError, callService } from "../../core/ajax.js";
+import { isoDate } from "../courses/list.js";
+import { setFields } from "../../core/forms.js";
+import { decodeEntities } from "../../core/text.js";
+import { MoodleError } from "../../core/errors.js";
+/** Moodle refused the event, or it isn't there. */
+export class CalendarError extends MoodleError {
+    name = "CalendarError";
+    constructor(message) {
+        super(message, "calendar");
+    }
+}
+function toEvent(raw) {
+    return {
+        id: raw.id,
+        name: decodeEntities(raw.name),
+        type: raw.eventtype,
+        start: isoDate(raw.timestart),
+        ...(raw.timeduration > 0 ? { durationMinutes: Math.round(raw.timeduration / 60) } : {}),
+        ...(raw.course ? { courseId: raw.course.id } : {}),
+        ...(raw.modulename && raw.instance ? { activity: { type: raw.modulename, instance: raw.instance } } : {}),
+    };
+}
+/** The person's upcoming events, as the calendar's "Upcoming events" view lists them, in one course or all. */
+export async function upcomingEvents(context, siteUrl, { courseId } = {}) {
+    // Course 1 is the site: every course the person is in.
+    const { events } = await callService(context, siteUrl, "core_calendar_get_calendar_upcoming_view", { courseid: courseId ?? 1, categoryid: 0 });
+    return events.map(toEvent);
+}
+/**
+ * Creates a course event, through the calendar's own form: its start, and its duration and
+ * description when given. Returns it as the calendar has it.
+ */
+export async function createEvent(context, siteUrl, { courseId, name, start, durationMinutes, description }) {
+    // The form takes its start as the time it's opened for: no date fields to fill in the person's time zone.
+    const fragment = await callService(context, siteUrl, "core_get_fragment", {
+        component: "core_calendar",
+        callback: "event_form",
+        contextid: 1,
+        args: [
+            { name: "courseid", value: String(courseId) },
+            { name: "starttime", value: String(Math.floor(start.getTime() / 1000)) },
+        ],
+    });
+    const page = await context.newPage();
+    let formdata;
+    try {
+        await page.setContent(fragment.html);
+        const types = await page.evaluate(() => Array.from(globalThis.document.querySelectorAll('form [name="eventtype"] option')).map((o) => o.value));
+        if (!types.includes("course"))
+            throw new CalendarError(`You can't add events to course ${courseId}'s calendar.`);
+        const values = { name, eventtype: "course", courseid: String(courseId) };
+        if (durationMinutes !== undefined)
+            Object.assign(values, { duration: 2, timedurationminutes: durationMinutes });
+        if (description !== undefined)
+            values["description[text]"] = description;
+        await setFields(page, values, "form");
+        formdata = await page.evaluate(() => {
+            const g = globalThis;
+            return new g.URLSearchParams(new g.FormData(g.document.querySelector("form"))).toString();
+        });
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+    const answer = await callService(context, siteUrl, "core_calendar_submit_create_update_form", { formdata });
+    if (!answer.event || answer.validationerror)
+        throw new CalendarError(`Moodle refused the event "${name}": check its name, start and duration.`);
+    const event = toEvent(answer.event);
+    return { changed: `Event ${event.id} "${event.name}" added to course ${courseId}'s calendar.`, event };
+}
+/** Deletes a calendar event the person can manage. */
+export async function deleteEvent(context, siteUrl, eventId) {
+    try {
+        await callService(context, siteUrl, "core_calendar_delete_calendar_events", { events: [{ eventid: eventId, repeat: false }] });
+    }
+    catch (error) {
+        if (error instanceof MoodleServiceError && /^invalidrecord/.test(error.errorcode))
+            throw new CalendarError(`There's no calendar event ${eventId}: it was deleted, or never existed.`);
+        throw error;
+    }
+    return { changed: `Event ${eventId} deleted.` };
+}
+//# sourceMappingURL=calendar.js.map

package/dist/areas/calendar/calendar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calendar.js","sourceRoot":"","sources":["../../../src/areas/calendar/calendar.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAmB,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,mDAAmD;AACnD,MAAM,OAAO,aAAc,SAAQ,WAAW;IACnC,IAAI,GAAG,eAAe,CAAC;IAChC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC7B,CAAC;CACF;AA0BD,SAAS,OAAO,CAAC,GAAgB;IAC/B,OAAO;QACL,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC;QAC9B,IAAI,EAAE,GAAG,CAAC,SAAS;QACnB,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,CAAE;QAC9B,GAAG,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvF,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,GAAG,CAAC,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1G,CAAC;AACJ,CAAC;AAED,+GAA+G;AAC/G,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAuB,EAAE,OAAe,EAAE,EAAE,QAAQ,KAA4B,EAAE;IACrH,uDAAuD;IACvD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,WAAW,CAA4B,OAAO,EAAE,OAAO,EAAE,0CAA0C,EAAE,EAAE,QAAQ,EAAE,QAAQ,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;IAC1K,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAAuB,EACvB,OAAe,EACf,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,eAAe,EAAE,WAAW,EAAmG;IAExJ,0GAA0G;IAC1G,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAmB,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE;QAC1F,SAAS,EAAE,eAAe;QAC1B,QAAQ,EAAE,YAAY;QACtB,SAAS,EAAE,CAAC;QACZ,IAAI,EAAE;YACJ,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE;YAC7C,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE;SACzE;KACF,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;IACrC,IAAI,QAAgB,CAAC;IACrB,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CACrC,KAAK,CAAC,IAAI,CAAE,UAAqG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,gCAAgC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CACnM,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,aAAa,CAAC,kCAAkC,QAAQ,cAAc,CAAC,CAAC;QACjH,MAAM,MAAM,GAA+B,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrG,IAAI,eAAe,KAAK,SAAS;YAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,mBAAmB,EAAE,eAAe,EAAE,CAAC,CAAC;QAChH,IAAI,WAAW,KAAK,SAAS;YAAE,MAAM,CAAC,mBAAmB,CAAC,GAAG,WAAW,CAAC;QACzE,MAAM,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACtC,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YAClC,MAAM,CAAC,GAAG,UAIT,CAAC;YACF,OAAO,IAAI,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC5F,CAAC,CAAC,CAAC;IACL,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAqD,OAAO,EAAE,OAAO,EAAE,yCAAyC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAChK,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,eAAe;QAAE,MAAM,IAAI,aAAa,CAAC,6BAA6B,IAAI,wCAAwC,CAAC,CAAC;IAChJ,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO,EAAE,OAAO,EAAE,SAAS,KAAK,CAAC,EAAE,KAAK,KAAK,CAAC,IAAI,qBAAqB,QAAQ,cAAc,EAAE,KAAK,EAAE,CAAC;AACzG,CAAC;AAED,sDAAsD;AACtD,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAuB,EAAE,OAAe,EAAE,OAAe;IACzF,IAAI,CAAC;QACH,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,sCAAsC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;IACjI,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,kBAAkB,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;YAAE,MAAM,IAAI,aAAa,CAAC,6BAA6B,OAAO,qCAAqC,CAAC,CAAC;QACtL,MAAM,KAAK,CAAC;IACd,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,SAAS,OAAO,WAAW,EAAE,CAAC;AAClD,CAAC"}

package/dist/areas/completion/completion.d.ts

@@ -0,0 +1,50 @@
+import type { BrowserContext, Page } from "playwright-core";
+import { type CompletionState } from "../courses/structure.js";
+import { MoodleError } from "../../core/errors.js";
+/** Completion can't be changed or read there: not enabled, automatic, or not allowed. */
+export declare class CompletionError extends MoodleError {
+    name: string;
+    constructor(message: string);
+}
+/**
+ * Marks the person's own completion of an activity with manual completion, done or not, as its
+ * "Mark as done" button does; doing it twice changes nothing. An activity that completes on its own
+ * gives a `CompletionError`.
+ */
+export declare function setCompletion(context: BrowserContext, siteUrl: string, activityId: number, done: boolean): Promise<{
+    changed: string;
+}>;
+/** Sets someone's completion of an activity as a teacher does from the progress report; returns the state saved. */
+export declare function overrideCompletion(context: BrowserContext, siteUrl: string, activityId: number, userId: number, state: CompletionState): Promise<{
+    changed: string;
+    state: CompletionState;
+    overridden: boolean;
+}>;
+export interface CompletionCell {
+    activityId: number;
+    state: CompletionState;
+    tracking: "manual" | "auto";
+    /** A teacher set it, not the person or Moodle. */
+    overridden: boolean;
+}
+export interface CompletionReport {
+    activities: {
+        id: number;
+        name: string;
+        type: string;
+    }[];
+    participants: {
+        userId: number;
+        fullName: string;
+        completion: CompletionCell[];
+    }[];
+}
+/** One page of the progress report: its activities from the header links, its rows' icons by name. */
+export declare function readCompletionReport(page: Page): Promise<CompletionReport>;
+/**
+ * A course's progress report: every participant's completion of every activity that tracks it, page
+ * by page, in one group when given. People come as user id and full name only.
+ */
+export declare function completionReport(context: BrowserContext, siteUrl: string, courseId: number, { group }?: {
+    group?: number;
+}): Promise<CompletionReport>;

package/dist/areas/completion/completion.js

@@ -0,0 +1,112 @@
+import { MoodleServiceError, callService } from "../../core/ajax.js";
+import { openSitePage } from "../../core/session.js";
+import { COMPLETION_STATES } from "../courses/structure.js";
+import { MoodleError } from "../../core/errors.js";
+/** Completion can't be changed or read there: not enabled, automatic, or not allowed. */
+export class CompletionError extends MoodleError {
+    name = "CompletionError";
+    constructor(message) {
+        super(message, "completion");
+    }
+}
+/** Moodle's refusals, in its terms. */
+function completionError(error, activityId) {
+    if (!(error instanceof MoodleServiceError))
+        return error;
+    if (error.errorcode === "cannotmanualctrack")
+        return new CompletionError(`Activity ${activityId} completes automatically (on view, grade, submission…): it can't be marked by hand.`);
+    if (error.errorcode === "completionnotenabled")
+        return new CompletionError(`Completion isn't enabled in activity ${activityId}'s course.`);
+    if (error.errorcode === "nopermissions" || error.errorcode === "nopermission")
+        return new CompletionError(`You aren't allowed to change completion in activity ${activityId}.`);
+    return error;
+}
+/**
+ * Marks the person's own completion of an activity with manual completion, done or not, as its
+ * "Mark as done" button does; doing it twice changes nothing. An activity that completes on its own
+ * gives a `CompletionError`.
+ */
+export async function setCompletion(context, siteUrl, activityId, done) {
+    try {
+        await callService(context, siteUrl, "core_completion_update_activity_completion_status_manually", { cmid: activityId, completed: done });
+    }
+    catch (error) {
+        throw completionError(error, activityId);
+    }
+    return { changed: `Activity ${activityId} marked ${done ? "done" : "not done"}.` };
+}
+/** Sets someone's completion of an activity as a teacher does from the progress report; returns the state saved. */
+export async function overrideCompletion(context, siteUrl, activityId, userId, state) {
+    let saved;
+    try {
+        saved = await callService(context, siteUrl, "core_completion_override_activity_completion_status", { userid: userId, cmid: activityId, newstate: COMPLETION_STATES.indexOf(state) });
+    }
+    catch (error) {
+        throw completionError(error, activityId);
+    }
+    const now = COMPLETION_STATES[saved.state] ?? "incomplete";
+    return { changed: `User ${userId}'s completion of activity ${activityId} set to ${now}.`, state: now, overridden: Boolean(saved.overrideby) };
+}
+/** One page of the progress report: its activities from the header links, its rows' icons by name. */
+export function readCompletionReport(page) {
+    return page.evaluate(() => {
+        const doc = globalThis.document;
+        const STATES = { n: "incomplete", y: "complete", pass: "complete-pass", fail: "complete-fail" };
+        const activities = Array.from(doc.querySelectorAll("#completion-progress thead th.completion-header a")).flatMap((link) => {
+            const match = /\/mod\/([a-z0-9_]+)\/view\.php\?(?:.*&)?id=(\d+)/.exec(link.getAttribute("href") ?? "");
+            return match ? [{ id: Number(match[2]), name: (link.getAttribute("title") ?? link.textContent ?? "").trim(), type: match[1] }] : [];
+        });
+        const participants = Array.from(doc.querySelectorAll("#completion-progress tbody tr")).flatMap((row) => {
+            const link = row.querySelector('th a[href*="/user/view.php?id="]');
+            const userId = Number(new URL(link?.getAttribute("href") ?? "", "http://x/").searchParams.get("id"));
+            if (!userId)
+                return [];
+            // One cell per activity, in the header's order; the icon's file names the state.
+            const completion = Array.from(row.querySelectorAll("td.completion-progresscell")).flatMap((cell, i) => {
+                const icon = /completion-(manual|auto)-(n|y|pass|fail)(-override)?/.exec(cell.querySelector("img")?.getAttribute("src") ?? "");
+                const activity = activities[i];
+                return icon && activity ? [{ activityId: activity.id, state: STATES[icon[2]], tracking: icon[1], overridden: icon[3] !== undefined }] : [];
+            });
+            return [{ userId, fullName: (link?.textContent ?? "").replace(/\s+/g, " ").trim(), completion }];
+        });
+        return { activities, participants };
+    });
+}
+const MAX_PAGES = 100;
+/**
+ * A course's progress report: every participant's completion of every activity that tracks it, page
+ * by page, in one group when given. People come as user id and full name only.
+ */
+export async function completionReport(context, siteUrl, courseId, { group } = {}) {
+    const report = { activities: [], participants: [] };
+    const seen = new Set();
+    let start = 0;
+    for (let p = 0; p < MAX_PAGES; p++) {
+        const page = await openSitePage(context, siteUrl, `report/progress/index.php?course=${courseId}&start=${start}${group ? `&group=${group}` : ""}`);
+        try {
+            // An error page keeps the report's body id; only the report has its activity selector.
+            if ((await page.locator("body#page-report-progress-index #include-activity-select-report").count()) === 0) {
+                throw new CompletionError(`You can't see course ${courseId}'s progress report: the course doesn't exist, or you aren't allowed.`);
+            }
+            if ((await page.locator("#completion-progress").count()) === 0) {
+                // The page explains in the site's language: no activity tracks completion, or nobody to list.
+                return report;
+            }
+            const read = await readCompletionReport(page);
+            if (p === 0)
+                report.activities = read.activities;
+            const fresh = read.participants.filter((row) => !seen.has(row.userId));
+            if (fresh.length === 0)
+                break;
+            for (const row of fresh)
+                seen.add(row.userId);
+            report.participants.push(...fresh);
+            start += read.participants.length;
+        }
+        finally {
+            await page.close().catch(() => undefined);
+        }
+    }
+    return report;
+}
+//# sourceMappingURL=completion.js.map

package/dist/areas/completion/completion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"completion.js","sourceRoot":"","sources":["../../../src/areas/completion/completion.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAwB,MAAM,yBAAyB,CAAC;AAClF,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,yFAAyF;AACzF,MAAM,OAAO,eAAgB,SAAQ,WAAW;IACrC,IAAI,GAAG,iBAAiB,CAAC;IAClC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC/B,CAAC;CACF;AAED,uCAAuC;AACvC,SAAS,eAAe,CAAC,KAAc,EAAE,UAAkB;IACzD,IAAI,CAAC,CAAC,KAAK,YAAY,kBAAkB,CAAC;QAAE,OAAO,KAAK,CAAC;IACzD,IAAI,KAAK,CAAC,SAAS,KAAK,oBAAoB;QAAE,OAAO,IAAI,eAAe,CAAC,YAAY,UAAU,qFAAqF,CAAC,CAAC;IACtL,IAAI,KAAK,CAAC,SAAS,KAAK,sBAAsB;QAAE,OAAO,IAAI,eAAe,CAAC,wCAAwC,UAAU,YAAY,CAAC,CAAC;IAC3I,IAAI,KAAK,CAAC,SAAS,KAAK,eAAe,IAAI,KAAK,CAAC,SAAS,KAAK,cAAc;QAAE,OAAO,IAAI,eAAe,CAAC,uDAAuD,UAAU,GAAG,CAAC,CAAC;IAChL,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAuB,EAAE,OAAe,EAAE,UAAkB,EAAE,IAAa;IAC7G,IAAI,CAAC;QACH,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,4DAA4D,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3I,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,eAAe,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,YAAY,UAAU,WAAW,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,GAAG,EAAE,CAAC;AACrF,CAAC;AAED,oHAAoH;AACpH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,OAAuB,EACvB,OAAe,EACf,UAAkB,EAClB,MAAc,EACd,KAAsB;IAEtB,IAAI,KAAmD,CAAC;IACxD,IAAI,CAAC;QACH,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,qDAAqD,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,iBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACvL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,eAAe,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IAC3C,CAAC;IACD,MAAM,GAAG,GAAG,iBAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC;IAC3D,OAAO,EAAE,OAAO,EAAE,QAAQ,MAAM,6BAA6B,UAAU,WAAW,GAAG,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;AAChJ,CAAC;AAeD,sGAAsG;AACtG,MAAM,UAAU,oBAAoB,CAAC,IAAU;IAC7C,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;QAOxB,MAAM,GAAG,GAAI,UAA0C,CAAC,QAAQ,CAAC;QACjE,MAAM,MAAM,GAA2B,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;QACxH,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,mDAAmD,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACxH,MAAM,KAAK,GAAG,kDAAkD,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACvG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACvI,CAAC,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,+BAA+B,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACrG,MAAM,IAAI,GAAG,GAAG,CAAC,aAAa,CAAC,kCAAkC,CAAC,CAAC;YACnE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;YACrG,IAAI,CAAC,MAAM;gBAAE,OAAO,EAAE,CAAC;YACvB,iFAAiF;YACjF,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,4BAA4B,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;gBACpG,MAAM,IAAI,GAAG,sDAAsD,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC/H,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;gBAC/B,OAAO,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAE,CAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAE,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAChJ,CAAC,CAAC,CAAC;YACH,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;QACnG,CAAC,CAAC,CAAC;QACH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAsB,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,SAAS,GAAG,GAAG,CAAC;AAEtB;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,EAAE,KAAK,KAAyB,EAAE;IACnI,MAAM,MAAM,GAAqB,EAAE,UAAU,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;IACtE,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,oCAAoC,QAAQ,UAAU,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAClJ,IAAI,CAAC;YACH,uFAAuF;YACvF,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,iEAAiE,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1G,MAAM,IAAI,eAAe,CAAC,wBAAwB,QAAQ,sEAAsE,CAAC,CAAC;YACpI,CAAC;YACD,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/D,8FAA8F;gBAC9F,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,MAAM,IAAI,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,CAAC,KAAK,CAAC;gBAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;YACjD,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;YACvE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAM;YAC9B,KAAK,MAAM,GAAG,IAAI,KAAK;gBAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;YACnC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QACpC,CAAC;gBAAS,CAAC;YACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -0,0 +1,59 @@
+import type { BrowserContext } from "playwright-core";
+import { type FieldValue } from "../../core/forms.js";
+import { MoodleError } from "../../core/errors.js";
+/** Which courses by their dates; "all" includes those the person hid from their dashboard. */
+export declare const COURSE_CLASSIFICATIONS: readonly ["all", "inprogress", "future", "past"];
+export type CourseClassification = (typeof COURSE_CLASSIFICATIONS)[number];
+export interface Course {
+    id: number;
+    shortname: string;
+    fullname: string;
+    category?: string;
+    url: string;
+    /** Whether students can see the course. */
+    visible: boolean;
+    startDate?: string;
+    endDate?: string;
+    /** The person's completion percentage, when the course tracks it. */
+    progress?: number;
+    /** When the person last opened the course. */
+    lastAccess?: string;
+}
+/** A course as `core_course_get_enrolled_courses_by_timeline_classification` returns it (Moodle 5.2). */
+export interface MoodleCourse {
+    id: number;
+    shortname: string;
+    fullname: string;
+    coursecategory?: string;
+    viewurl: string;
+    visible: boolean;
+    startdate?: number;
+    enddate?: number;
+    progress?: number | null;
+    hasprogress?: boolean;
+    timeaccess?: number | null;
+}
+/** Unix seconds as ISO 8601; Moodle uses 0 for "none". */
+export declare function isoDate(seconds: number | null | undefined): string | undefined;
+export declare function toCourse(raw: MoodleCourse): Course;
+/** The courses the person is enrolled in, as teacher or student. */
+export declare function listCourses(context: BrowserContext, siteUrl: string, classification?: CourseClassification): Promise<Course[]>;
+/** A course that isn't there, or the person can't change. */
+export declare class CourseError extends MoodleError {
+    name: string;
+    constructor(message: string);
+}
+/**
+ * Changes a course's full name, short name, summary (HTML) or any other setting by its form field
+ * name, through the course's settings form; returns the course as `listCourses` gives it. Moodle's
+ * refusals (a short name already taken) come back as `FormError` by field.
+ */
+export declare function updateCourse(context: BrowserContext, siteUrl: string, courseId: number, { fullName, shortName, summary, settings }: {
+    fullName?: string;
+    shortName?: string;
+    summary?: string;
+    settings?: Record<string, FieldValue>;
+}): Promise<{
+    changed: string;
+    course?: Course;
+}>;

package/dist/areas/courses/list.js

@@ -0,0 +1,74 @@
+import { callService } from "../../core/ajax.js";
+import { openForm, setFields, submitForm } from "../../core/forms.js";
+import { NotLoggedInError } from "../../core/session.js";
+import { decodeEntities } from "../../core/text.js";
+import { MoodleError } from "../../core/errors.js";
+/** Which courses by their dates; "all" includes those the person hid from their dashboard. */
+export const COURSE_CLASSIFICATIONS = ["all", "inprogress", "future", "past"];
+const MOODLE_CLASSIFICATIONS = { all: "allincludinghidden", inprogress: "inprogress", future: "future", past: "past" };
+/** Unix seconds as ISO 8601; Moodle uses 0 for "none". */
+export function isoDate(seconds) {
+    return seconds ? new Date(seconds * 1000).toISOString() : undefined;
+}
+export function toCourse(raw) {
+    return {
+        id: raw.id,
+        shortname: decodeEntities(raw.shortname),
+        fullname: decodeEntities(raw.fullname),
+        category: raw.coursecategory ? decodeEntities(raw.coursecategory) : undefined,
+        url: raw.viewurl,
+        visible: raw.visible,
+        startDate: isoDate(raw.startdate),
+        endDate: isoDate(raw.enddate),
+        progress: raw.hasprogress && typeof raw.progress === "number" ? raw.progress : undefined,
+        lastAccess: isoDate(raw.timeaccess),
+    };
+}
+/** The courses the person is enrolled in, as teacher or student. */
+export async function listCourses(context, siteUrl, classification = "all") {
+    const { courses } = await callService(context, siteUrl, "core_course_get_enrolled_courses_by_timeline_classification", {
+        classification: MOODLE_CLASSIFICATIONS[classification],
+        limit: 0,
+        offset: 0,
+        sort: "fullname",
+    });
+    return courses.map(toCourse);
+}
+/** A course that isn't there, or the person can't change. */
+export class CourseError extends MoodleError {
+    name = "CourseError";
+    constructor(message) {
+        super(message, "course");
+    }
+}
+/**
+ * Changes a course's full name, short name, summary (HTML) or any other setting by its form field
+ * name, through the course's settings form; returns the course as `listCourses` gives it. Moodle's
+ * refusals (a short name already taken) come back as `FormError` by field.
+ */
+export async function updateCourse(context, siteUrl, courseId, { fullName, shortName, summary, settings }) {
+    const values = { ...settings };
+    if (fullName !== undefined)
+        values.fullname = fullName;
+    if (shortName !== undefined)
+        values.shortname = shortName;
+    if (summary !== undefined)
+        values["summary_editor[text]"] = summary;
+    if (Object.keys(values).length === 0)
+        return { changed: "Nothing to change.", course: (await listCourses(context, siteUrl)).find((c) => c.id === courseId) };
+    const page = await openForm(context, siteUrl, `course/edit.php?id=${courseId}`).catch((error) => {
+        if (error instanceof NotLoggedInError)
+            throw error;
+        throw new CourseError(`You can't change course ${courseId}'s settings: it doesn't exist, or you aren't allowed.`);
+    });
+    try {
+        await setFields(page, values);
+        await submitForm(page, "saveanddisplay");
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+    const course = (await listCourses(context, siteUrl)).find((c) => c.id === courseId);
+    return { changed: `Course ${courseId} updated (${Object.keys(values).join(", ")}).`, course };
+}
+//# sourceMappingURL=list.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../src/areas/courses/list.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAC;AACvF,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,8FAA8F;AAC9F,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAC;AAGvF,MAAM,sBAAsB,GAAyC,EAAE,GAAG,EAAE,oBAAoB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAiC7J,0DAA0D;AAC1D,MAAM,UAAU,OAAO,CAAC,OAAkC;IACxD,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,GAAiB;IACxC,OAAO;QACL,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,SAAS,EAAE,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC;QACxC,QAAQ,EAAE,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC;QACtC,QAAQ,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,SAAS;QAC7E,GAAG,EAAE,GAAG,CAAC,OAAO;QAChB,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;QACjC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;QAC7B,QAAQ,EAAE,GAAG,CAAC,WAAW,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;QACxF,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;KACpC,CAAC;AACJ,CAAC;AAED,oEAAoE;AACpE,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAuB,EAAE,OAAe,EAAE,iBAAuC,KAAK;IACtH,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,WAAW,CAA8B,OAAO,EAAE,OAAO,EAAE,6DAA6D,EAAE;QAClJ,cAAc,EAAE,sBAAsB,CAAC,cAAc,CAAC;QACtD,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,CAAC;QACT,IAAI,EAAE,UAAU;KACjB,CAAC,CAAC;IACH,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAED,6DAA6D;AAC7D,MAAM,OAAO,WAAY,SAAQ,WAAW;IACjC,IAAI,GAAG,aAAa,CAAC;IAC9B,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,OAAuB,EACvB,OAAe,EACf,QAAgB,EAChB,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAsG;IAE9I,MAAM,MAAM,GAA+B,EAAE,GAAG,QAAQ,EAAE,CAAC;IAC3D,IAAI,QAAQ,KAAK,SAAS;QAAE,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;IACvD,IAAI,SAAS,KAAK,SAAS;QAAE,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;IAC1D,IAAI,OAAO,KAAK,SAAS;QAAE,MAAM,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC;IACpE,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,CAAC,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,EAAE,CAAC;IAC7J,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,sBAAsB,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACvG,IAAI,KAAK,YAAY,gBAAgB;YAAE,MAAM,KAAK,CAAC;QACnD,MAAM,IAAI,WAAW,CAAC,2BAA2B,QAAQ,uDAAuD,CAAC,CAAC;IACpH,CAAC,CAAC,CAAC;IACH,IAAI,CAAC;QACH,MAAM,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9B,MAAM,UAAU,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;IAC3C,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,MAAM,GAAG,CAAC,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;IACpF,OAAO,EAAE,OAAO,EAAE,UAAU,QAAQ,aAAa,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;AAChG,CAAC"}