@falkenslab/moodle-driver 0.0.0-stage → 0.4.0

package/dist/moodle/session.d.ts

@@ -0,0 +1,39 @@
+import type { BrowserContext, Page } from "playwright-core";
+/** No live Moodle session: the person has to log in again (ADR-002). */
+export declare class NotLoggedInError extends Error {
+    name: string;
+    constructor();
+}
+/** What a Moodle page says about its session, read without depending on the interface's language. */
+export interface SessionFacts {
+    /** Moodle adds the `notloggedin` body class when nobody is logged in. */
+    notLoggedIn: boolean;
+    /** `M.cfg.userId`: 0 when logged out; `null` on a page that isn't Moodle's (an SSO provider's). */
+    userId: number | null;
+    /** A logout link, in the user menu of a real user's pages. */
+    hasLogoutLink: boolean;
+    /** A login link: a guest (who also has a user id) gets one and no logout link. */
+    hasLoginLink: boolean;
+}
+export declare function readSessionFacts(page: Page): Promise<SessionFacts>;
+/** Whether a page at `url`, with these facts, belongs to the site and has a real user logged in. */
+export declare function isLoggedIn(url: string, siteUrl: string, facts: SessionFacts): boolean;
+/** Whether `page`, as it is now, shows the site with a real user logged in. */
+export declare function pageIsLoggedIn(page: Page, siteUrl: string): Promise<boolean>;
+/** Has `show` called with the page each function opened, once it's done with it. */
+export declare function followPages(context: BrowserContext, show: (url: string) => Promise<void>): void;
+/**
+ * Opens a page of the site (`path` relative to it) in a new tab and checks the session; throws
+ * `NotLoggedInError`, closing the tab, when Moodle answers with its login page.
+ */
+export declare function openSitePage(context: BrowserContext, siteUrl: string, path: string, { follow }?: {
+    follow?: boolean | undefined;
+}): Promise<Page>;
+/**
+ * Logs the person out of Moodle through the user menu's logout link (it carries the sesskey; without
+ * one Moodle asks to confirm, and the confirmation is accepted). Returns false when nobody was logged
+ * in. Only Moodle's session ends: a single sign-on provider may keep its own.
+ */
+export declare function logOut(context: BrowserContext, siteUrl: string): Promise<boolean>;
+/** Moodle's message on an error page (its fatal error box: no permission, no such record), which keeps the page's body id. */
+export declare function moodleErrorMessage(page: Page): Promise<string | undefined>;

package/dist/moodle/session.js

@@ -0,0 +1,99 @@
+/** No live Moodle session: the person has to log in again (ADR-002). */
+export class NotLoggedInError extends Error {
+    name = "NotLoggedInError";
+    constructor() {
+        super("There is no Moodle session, or it expired: the person has to log in again.");
+    }
+}
+export function readSessionFacts(page) {
+    return page.evaluate(() => {
+        // Runs in the page: Moodle's globals and the DOM, typed loosely on purpose (no DOM lib in Node).
+        const g = globalThis;
+        const userId = g.M?.cfg?.userId;
+        return {
+            notLoggedIn: g.document.body?.classList.contains("notloggedin") ?? true,
+            userId: typeof userId === "number" ? userId : null,
+            hasLogoutLink: g.document.querySelector('a[href*="/login/logout.php"]') !== null,
+            hasLoginLink: g.document.querySelector('a[href*="/login/index.php"]') !== null,
+        };
+    });
+}
+/** Whether a page at `url`, with these facts, belongs to the site and has a real user logged in. */
+export function isLoggedIn(url, siteUrl, facts) {
+    if (!url.startsWith(siteUrl))
+        return false;
+    if (url.startsWith(new URL("login/", siteUrl).href))
+        return false;
+    // Pages without the navigation bar (the assignment grader) have neither link (confirmed empirically,
+    // Moodle 5.2): only a login link without a logout one means a guest.
+    const guest = facts.hasLoginLink && !facts.hasLogoutLink;
+    return !facts.notLoggedIn && (facts.userId ?? 0) > 0 && !guest;
+}
+/** Whether `page`, as it is now, shows the site with a real user logged in. */
+export async function pageIsLoggedIn(page, siteUrl) {
+    return isLoggedIn(page.url(), siteUrl, await readSessionFacts(page));
+}
+// While the person watches (ADR-007), a context's browser manager shows the pages functions worked on.
+const followers = new WeakMap();
+/** Has `show` called with the page each function opened, once it's done with it. */
+export function followPages(context, show) {
+    followers.set(context, show);
+}
+/**
+ * Opens a page of the site (`path` relative to it) in a new tab and checks the session; throws
+ * `NotLoggedInError`, closing the tab, when Moodle answers with its login page.
+ */
+export async function openSitePage(context, siteUrl, path, { follow = true } = {}) {
+    const page = await context.newPage();
+    try {
+        await page.goto(new URL(path, siteUrl).href, { waitUntil: "domcontentloaded" });
+        if (!(await pageIsLoggedIn(page, siteUrl)))
+            throw new NotLoggedInError();
+        // The page as it was opened (a form's URL, not where posting it led), once it's closed.
+        const opened = page.url();
+        if (follow)
+            page.once("close", () => void followers.get(context)?.(opened));
+        return page;
+    }
+    catch (error) {
+        await page.close().catch(() => undefined);
+        throw error;
+    }
+}
+/**
+ * Logs the person out of Moodle through the user menu's logout link (it carries the sesskey; without
+ * one Moodle asks to confirm, and the confirmation is accepted). Returns false when nobody was logged
+ * in. Only Moodle's session ends: a single sign-on provider may keep its own.
+ */
+export async function logOut(context, siteUrl) {
+    const page = await context.newPage();
+    const home = new URL("my/", siteUrl).href;
+    try {
+        await page.goto(home, { waitUntil: "domcontentloaded" });
+        if (!(await pageIsLoggedIn(page, siteUrl)))
+            return false;
+        const link = await page.locator('a[href*="/login/logout.php"]').first().getAttribute("href").catch(() => null);
+        // Moodle's redirect after logging out can abort this navigation (ERR_ABORTED, confirmed empirically,
+        // Moodle 5.2); whether the session ended is checked below either way.
+        await page.goto(new URL(link ?? "login/logout.php", siteUrl).href, { waitUntil: "domcontentloaded" }).catch((error) => {
+            if (!/ERR_ABORTED/.test(error.message))
+                throw error;
+        });
+        const confirm = page.locator('form[action*="/login/logout.php"] [type="submit"]');
+        if ((await confirm.count()) > 0)
+            await Promise.all([page.waitForNavigation({ waitUntil: "domcontentloaded" }), confirm.first().click()]);
+        await page.goto(home, { waitUntil: "domcontentloaded" });
+        if (await pageIsLoggedIn(page, siteUrl))
+            throw new Error("Moodle didn't end the session: the person is still logged in. Try again, or log out in the browser.");
+        return true;
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+}
+/** Moodle's message on an error page (its fatal error box: no permission, no such record), which keeps the page's body id. */
+export async function moodleErrorMessage(page) {
+    const box = page.locator('[data-rel="fatalerror"] .errormessage');
+    return (await box.count()) > 0 ? ((await box.first().textContent()) ?? "").replace(/\s+/g, " ").trim() : undefined;
+}
+//# sourceMappingURL=session.js.map

package/dist/moodle/session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.js","sourceRoot":"","sources":["../../src/moodle/session.ts"],"names":[],"mappings":"AAEA,wEAAwE;AACxE,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAChC,IAAI,GAAG,kBAAkB,CAAC;IACnC;QACE,KAAK,CAAC,4EAA4E,CAAC,CAAC;IACtF,CAAC;CACF;AAcD,MAAM,UAAU,gBAAgB,CAAC,IAAU;IACzC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;QACxB,iGAAiG;QACjG,MAAM,CAAC,GAAG,UAGT,CAAC;QACF,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC;QAChC,OAAO;YACL,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,IAAI;YACvE,MAAM,EAAE,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;YAClD,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,8BAA8B,CAAC,KAAK,IAAI;YAChF,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,6BAA6B,CAAC,KAAK,IAAI;SAC/E,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,UAAU,CAAC,GAAW,EAAE,OAAe,EAAE,KAAmB;IAC1E,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IAC3C,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAClE,qGAAqG;IACrG,qEAAqE;IACrE,MAAM,KAAK,GAAG,KAAK,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC;IACzD,OAAO,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;AACjE,CAAC;AAED,+EAA+E;AAC/E,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,IAAU,EAAE,OAAe;IAC9D,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,uGAAuG;AACvG,MAAM,SAAS,GAAG,IAAI,OAAO,EAAkD,CAAC;AAEhF,oFAAoF;AACpF,MAAM,UAAU,WAAW,CAAC,OAAuB,EAAE,IAAoC;IACvF,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAuB,EAAE,OAAe,EAAE,IAAY,EAAE,EAAE,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE;IAC/G,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;IACrC,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,CAAC,MAAM,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAAE,MAAM,IAAI,gBAAgB,EAAE,CAAC;QACzE,wFAAwF;QACxF,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC1B,IAAI,MAAM;YAAE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,OAAuB,EAAE,OAAe;IACnE,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;IAC1C,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,CAAC,MAAM,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QACzD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,8BAA8B,CAAC,CAAC,KAAK,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QAC/G,qGAAqG;QACrG,sEAAsE;QACtE,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,kBAAkB,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;YAC3H,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;gBAAE,MAAM,KAAK,CAAC;QACtD,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,mDAAmD,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC;YAAE,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,SAAS,EAAE,kBAAkB,EAAE,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzI,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,CAAC,CAAC;QACzD,IAAI,MAAM,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,qGAAqG,CAAC,CAAC;QAChK,OAAO,IAAI,CAAC;IACd,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED,8HAA8H;AAC9H,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,IAAU;IACjD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,uCAAuC,CAAC,CAAC;IAClE,OAAO,CAAC,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AACrH,CAAC"}

package/dist/moodle/site.d.ts

@@ -0,0 +1,8 @@
+/** `M.cfg.wwwroot` in a Moodle page, JSON-escaped as Moodle writes it (`"http:\/\/host"`). */
+export declare function readWwwroot(html: string): string | undefined;
+/**
+ * The site's base URL for any URL of it (the site, a course, the login page), read from the
+ * `M.cfg.wwwroot` Moodle puts in every page; fetched without the browser or any session. Throws
+ * `MoodleUrlError` when it can't be reached or isn't a Moodle.
+ */
+export declare function findMoodleSite(url: string, fetchImpl?: typeof fetch): Promise<string>;

package/dist/moodle/site.js

@@ -0,0 +1,36 @@
+import { MoodleUrlError, parseSiteUrl } from "../options.js";
+// The first answer of a site that just started can take long (confirmed empirically, the sandbox).
+const TIMEOUT_MS = 60_000;
+/** `M.cfg.wwwroot` in a Moodle page, JSON-escaped as Moodle writes it (`"http:\/\/host"`). */
+export function readWwwroot(html) {
+    const match = /"wwwroot":"((?:[^"\\]|\\.)*)"/.exec(html);
+    if (!match)
+        return undefined;
+    try {
+        return JSON.parse(`"${match[1]}"`);
+    }
+    catch {
+        return undefined;
+    }
+}
+/**
+ * The site's base URL for any URL of it (the site, a course, the login page), read from the
+ * `M.cfg.wwwroot` Moodle puts in every page; fetched without the browser or any session. Throws
+ * `MoodleUrlError` when it can't be reached or isn't a Moodle.
+ */
+export async function findMoodleSite(url, fetchImpl = fetch) {
+    parseSiteUrl(url); // http(s) and well formed, or MoodleUrlError.
+    let html;
+    try {
+        const response = await fetchImpl(url.trim(), { redirect: "follow", signal: AbortSignal.timeout(TIMEOUT_MS) });
+        html = await response.text();
+    }
+    catch (error) {
+        throw new MoodleUrlError(`Couldn't reach ${url}: ${error.message}. Check the URL and that the site is up.`);
+    }
+    const wwwroot = readWwwroot(html);
+    if (!wwwroot)
+        throw new MoodleUrlError(`${url} doesn't look like a Moodle site (its page has no M.cfg.wwwroot). Check the URL.`);
+    return parseSiteUrl(wwwroot);
+}
+//# sourceMappingURL=site.js.map

package/dist/moodle/site.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.js","sourceRoot":"","sources":["../../src/moodle/site.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7D,mGAAmG;AACnG,MAAM,UAAU,GAAG,MAAM,CAAC;AAE1B,8FAA8F;AAC9F,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,KAAK,GAAG,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzD,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,CAAW,CAAC;IAC/C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,GAAW,EAAE,YAA0B,KAAK;IAC/E,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,8CAA8C;IACjE,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC9G,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,cAAc,CAAC,kBAAkB,GAAG,KAAM,KAAe,CAAC,OAAO,0CAA0C,CAAC,CAAC;IACzH,CAAC;IACD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,cAAc,CAAC,GAAG,GAAG,kFAAkF,CAAC,CAAC;IACjI,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC"}

package/dist/moodle/siteInfo.d.ts

@@ -0,0 +1,25 @@
+import type { BrowserContext } from "playwright-core";
+/**
+ * What the site tells anyone about itself, through Moodle's AJAX entry point for services that need
+ * no login (`service-nologin.php`): readable before logging in, without the browser. Moodle shows its
+ * version only to administrators, so it isn't here.
+ */
+export declare function publicSiteInfo(siteUrl: string, fetchImpl?: typeof fetch): Promise<{
+    supportPage?: string | undefined;
+    maintenance?: string | undefined;
+    login: {
+        guestAccess: boolean;
+        identityProviders: string[];
+        appLogin?: "app" | "browser" | "embedded" | undefined;
+    };
+    languages?: string[] | undefined;
+    name: string;
+    url: string;
+    language: string | undefined;
+}>;
+/** The activity and resource types the person can add to a course: none when they can't edit it. */
+export declare function courseActivityTypes(context: BrowserContext, siteUrl: string, courseId: number): Promise<{
+    purpose?: string | undefined;
+    type: string;
+    title: string;
+}[]>;

package/dist/moodle/siteInfo.js

@@ -0,0 +1,45 @@
+import { callService, parseServiceResponse } from "./ajax.js";
+import { decodeEntities } from "./text.js";
+const TIMEOUT_MS = 60_000;
+// typeoflogin: how the mobile app is told to log in, which says whether the site uses its own form.
+const LOGIN_TYPES = { 1: "app", 2: "browser", 3: "embedded" };
+/**
+ * What the site tells anyone about itself, through Moodle's AJAX entry point for services that need
+ * no login (`service-nologin.php`): readable before logging in, without the browser. Moodle shows its
+ * version only to administrators, so it isn't here.
+ */
+export async function publicSiteInfo(siteUrl, fetchImpl = fetch) {
+    const methodname = "tool_mobile_get_public_config";
+    const response = await fetchImpl(new URL(`lib/ajax/service-nologin.php?info=${methodname}`, siteUrl).href, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify([{ index: 0, methodname, args: {} }]),
+        signal: AbortSignal.timeout(TIMEOUT_MS),
+    });
+    const config = parseServiceResponse(methodname, response.status, await response.text());
+    // "en|English,es|Español": the languages the menu offers; empty means every installed one.
+    const languages = (config.langlist ?? "").split(",").map((entry) => entry.split("|")[0]?.trim() ?? "").filter(Boolean);
+    return {
+        name: decodeEntities(config.sitename),
+        url: config.wwwroot,
+        language: config.lang,
+        ...(languages.length > 0 ? { languages } : {}),
+        login: {
+            ...(config.typeoflogin !== undefined && LOGIN_TYPES[config.typeoflogin] ? { appLogin: LOGIN_TYPES[config.typeoflogin] } : {}),
+            guestAccess: config.guestlogin === 1,
+            identityProviders: (config.identityproviders ?? []).map((p) => decodeEntities(p.name)),
+        },
+        ...(config.maintenanceenabled ? { maintenance: decodeEntities(config.maintenancemessage ?? "") || "The site is in maintenance mode." } : {}),
+        ...(config.supportpage ? { supportPage: config.supportpage } : {}),
+    };
+}
+/** The activity and resource types the person can add to a course: none when they can't edit it. */
+export async function courseActivityTypes(context, siteUrl, courseId) {
+    const { content_items: items } = await callService(context, siteUrl, "core_course_get_course_content_items", { courseid: courseId });
+    // A type with several items (LTI tools) is listed once.
+    const seen = new Set();
+    return items
+        .filter((item) => !seen.has(item.name) && seen.add(item.name))
+        .map((item) => ({ type: item.name, title: decodeEntities(item.title), ...(item.purpose ? { purpose: item.purpose } : {}) }));
+}
+//# sourceMappingURL=siteInfo.js.map

package/dist/moodle/siteInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"siteInfo.js","sourceRoot":"","sources":["../../src/moodle/siteInfo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C,MAAM,UAAU,GAAG,MAAM,CAAC;AAgB1B,oGAAoG;AACpG,MAAM,WAAW,GAAmD,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;AAE9G;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAe,EAAE,YAA0B,KAAK;IACnF,MAAM,UAAU,GAAG,+BAA+B,CAAC;IACnD,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,IAAI,GAAG,CAAC,qCAAqC,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE;QACzG,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;QAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1D,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC;KACxC,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,oBAAoB,CAAe,UAAU,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IACtG,2FAA2F;IAC3F,MAAM,SAAS,GAAG,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACvH,OAAO;QACL,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC;QACrC,GAAG,EAAE,MAAM,CAAC,OAAO;QACnB,QAAQ,EAAE,MAAM,CAAC,IAAI;QACrB,GAAG,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,KAAK,EAAE;YACL,GAAG,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,IAAI,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7H,WAAW,EAAE,MAAM,CAAC,UAAU,KAAK,CAAC;YACpC,iBAAiB,EAAE,CAAC,MAAM,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACvF;QACD,GAAG,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,cAAc,CAAC,MAAM,CAAC,kBAAkB,IAAI,EAAE,CAAC,IAAI,kCAAkC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5I,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnE,CAAC;AACJ,CAAC;AAED,oGAAoG;AACpG,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB;IAClG,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,MAAM,WAAW,CAAyE,OAAO,EAAE,OAAO,EAAE,sCAAsC,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7M,wDAAwD;IACxD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,OAAO,KAAK;SACT,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC7D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AACjI,CAAC"}

package/dist/moodle/structure.d.ts

@@ -0,0 +1,94 @@
+import type { BrowserContext } from "playwright-core";
+import { type ActivityDetails, type CourseState } from "./course.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<{
+    course: {
+        id: number;
+        url: string | undefined;
+    };
+    sections: 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[];
+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/moodle/structure.js

@@ -0,0 +1,103 @@
+import { activityDetails, courseState } from "./course.js";
+import { myGrades } from "./grades.js";
+import { decodeEntities } from "./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 { course: { id: courseId, url: state.course?.baseurl }, sections: 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 ?? "") },
+        };
+    });
+}
+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/moodle/structure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"structure.js","sourceRoot":"","sources":["../../src/moodle/structure.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,WAAW,EAA0C,MAAM,aAAa,CAAC;AACnG,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C,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,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;AACvG,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,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/moodle/submission.d.ts

@@ -0,0 +1,48 @@
+import type { BrowserContext, Page } from "playwright-core";
+/** The assignment isn't there, or the person can't do that now. */
+export declare class SubmissionError extends Error {
+    name: 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>;
+export declare function studentAssignment(context: BrowserContext, siteUrl: string, cmid: 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, cmid: number, input: {
+    onlineText?: string;
+    files?: string[];
+}): Promise<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, cmid: number, options?: {
+    acceptStatement?: boolean;
+} | boolean): Promise<StudentAssignment>;

package/dist/moodle/submission.js

@@ -0,0 +1,109 @@
+import { checkLocalFiles } from "./files.js";
+import { formValue, openForm, setFields, submitForm, uploadToDraft } from "./forms.js";
+import { inPage } from "./inPage.js";
+import { NotLoggedInError, openSitePage } from "./session.js";
+/** The assignment isn't there, or the person can't do that now. */
+export class SubmissionError extends Error {
+    name = "SubmissionError";
+}
+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);
+}
+export async function studentAssignment(context, siteUrl, cmid) {
+    const page = await openSitePage(context, siteUrl, `mod/assign/view.php?id=${cmid}`);
+    try {
+        if ((await page.locator("body#page-mod-assign-view").count()) === 0) {
+            throw new SubmissionError(`Activity ${cmid} 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, cmid, 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=${cmid}&action=editsubmission`).catch((error) => {
+        if (error instanceof NotLoggedInError)
+            throw error;
+        throw new SubmissionError(`You can't edit a submission to assignment ${cmid} 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 ${cmid} 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 ${cmid} 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);
+    }
+    return studentAssignment(context, siteUrl, cmid);
+}
+/**
+ * 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, cmid, options = {}) {
+    const acceptStatement = typeof options === "boolean" ? options : (options.acceptStatement ?? false);
+    const page = await openForm(context, siteUrl, `mod/assign/view.php?id=${cmid}&action=submit`).catch((error) => {
+        if (error instanceof NotLoggedInError)
+            throw error;
+        throw new SubmissionError(`Assignment ${cmid} 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 studentAssignment(context, siteUrl, cmid);
+}
+//# sourceMappingURL=submission.js.map