@falkenslab/moodle-driver 0.0.0-stage → 0.3.1

package/dist/moodle/login.js

@@ -0,0 +1,77 @@
+import { NotLoggedInError, openSitePage, pageIsLoggedIn } from "./session.js";
+const POLL_MS = 1000;
+export class LoginTimeoutError extends Error {
+    name = "LoginTimeoutError";
+}
+export class LoginWindowClosedError extends Error {
+    name = "LoginWindowClosedError";
+    constructor() {
+        super("The login window was closed before the person logged in.");
+    }
+}
+/** The logged-in user, read from their own profile page (`user/profile.php`). */
+export async function readOwnProfile(context, siteUrl) {
+    const page = await openSitePage(context, siteUrl, "user/profile.php");
+    try {
+        return await page.evaluate(() => {
+            const g = globalThis;
+            // The page heading is the user's full name, in any interface language.
+            const heading = g.document.querySelector("#page-header h1, .page-header-headings h1, h1");
+            return { userId: g.M.cfg.userId, fullName: heading?.textContent?.trim() ?? "" };
+        });
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+}
+/**
+ * Waits until `page` shows the site with a user logged in. The person may go through other domains
+ * (SSO) on the way; reads fail while a page navigates, and are retried.
+ */
+export async function waitForLogin(page, siteUrl, { timeoutMs, pollMs = POLL_MS, onWait }) {
+    const start = Date.now();
+    for (;;) {
+        if (page.isClosed())
+            throw new LoginWindowClosedError();
+        if (await pageIsLoggedIn(page, siteUrl).catch(() => false))
+            return;
+        const elapsed = Date.now() - start;
+        if (elapsed >= timeoutMs)
+            throw new LoginTimeoutError(`Nobody logged in within ${Math.round(timeoutMs / 1000)} seconds; the window was closed.`);
+        onWait?.(elapsed);
+        await new Promise((resolve) => setTimeout(resolve, pollMs));
+    }
+}
+/**
+ * Makes sure there's a session: the user at once if there is one; otherwise a browser window at the
+ * site's login page, waiting (calling `onWait`) until the person logs in there themselves. The session
+ * is saved (ADR-003), and the window closes again unless the browser is shown on demand.
+ */
+export async function logIn(browser, siteUrl, { timeoutMs, onWait }) {
+    try {
+        return { status: "already-logged-in", ...(await readOwnProfile(await browser.context(), siteUrl)) };
+    }
+    catch (error) {
+        if (!(error instanceof NotLoggedInError))
+            throw error;
+    }
+    const context = await browser.context({ headed: true });
+    const page = context.pages()[0] ?? (await context.newPage());
+    await page.goto(new URL("login/index.php", siteUrl).href, { waitUntil: "domcontentloaded" });
+    await page.bringToFront();
+    try {
+        await waitForLogin(page, siteUrl, { timeoutMs, onWait });
+    }
+    catch (error) {
+        if (error instanceof LoginTimeoutError)
+            await browser.close();
+        throw error;
+    }
+    const user = await readOwnProfile(context, siteUrl);
+    await browser.saveSession();
+    // Back to the chosen mode: the next call reopens the browser without a window.
+    if (!browser.visible())
+        await browser.close();
+    return { status: "logged-in", ...user };
+}
+//# sourceMappingURL=login.js.map

package/dist/moodle/login.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"login.js","sourceRoot":"","sources":["../../src/moodle/login.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9E,MAAM,OAAO,GAAG,IAAI,CAAC;AAErB,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IACjC,IAAI,GAAG,mBAAmB,CAAC;CACrC;AAED,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IACtC,IAAI,GAAG,wBAAwB,CAAC;IACzC;QACE,KAAK,CAAC,0DAA0D,CAAC,CAAC;IACpE,CAAC;CACF;AAED,iFAAiF;AACjF,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAuB,EAAE,OAAe;IAC3E,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;IACtE,IAAI,CAAC;QACH,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YAC9B,MAAM,CAAC,GAAG,UAGT,CAAC;YACF,uEAAuE;YACvE,MAAM,OAAO,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,+CAA+C,CAAC,CAAC;YAC1F,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC;QAClF,CAAC,CAAC,CAAC;IACL,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,IAAU,EACV,OAAe,EACf,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,EAAE,MAAM,EAAgF;IAErH,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,SAAS,CAAC;QACR,IAAI,IAAI,CAAC,QAAQ,EAAE;YAAE,MAAM,IAAI,sBAAsB,EAAE,CAAC;QACxD,IAAI,MAAM,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC;YAAE,OAAO;QACnE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QACnC,IAAI,OAAO,IAAI,SAAS;YAAE,MAAM,IAAI,iBAAiB,CAAC,2BAA2B,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,kCAAkC,CAAC,CAAC;QACjJ,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC;QAClB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AAQD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAAuB,EAAE,OAAe,EAAE,EAAE,SAAS,EAAE,MAAM,EAA+D;IACtJ,IAAI,CAAC;QACH,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE,GAAG,CAAC,MAAM,cAAc,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;IACtG,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,gBAAgB,CAAC;YAAE,MAAM,KAAK,CAAC;IACxD,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAC7D,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC7F,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;IAC1B,IAAI,CAAC;QACH,MAAM,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,iBAAiB;YAAE,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QAC9D,MAAM,KAAK,CAAC;IACd,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACpD,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC;IAC5B,+EAA+E;IAC/E,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;QAAE,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;IAC9C,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,CAAC;AAC1C,CAAC"}

package/dist/moodle/messages.d.ts

@@ -0,0 +1,66 @@
+import type { BrowserContext } from "playwright-core";
+/** Moodle didn't deliver a message. */
+export declare class MessageError extends Error {
+    name: string;
+}
+export interface Notification {
+    id: number;
+    subject: string;
+    /** The notification's text, plain. */
+    text: string;
+    /** Who it's from: a user id, or a negative one for the site itself (noreply, support). */
+    fromUserId: number;
+    time?: string;
+    read: boolean;
+    /** Where it leads (the post, the assignment…). */
+    url?: string;
+    /** What sent it: "mod_forum", "mod_assign"… and its kind. */
+    component?: string;
+    eventType?: string;
+}
+/** The person's notifications, newest first, only the unread ones when asked. */
+export declare function notifications(context: BrowserContext, siteUrl: string, { unreadOnly }?: {
+    unreadOnly?: boolean;
+}): Promise<Notification[]>;
+/** Marks all the person's notifications read, as the popover's "Mark all as read" does; doing it twice changes nothing. */
+export declare function markNotificationsRead(context: BrowserContext, siteUrl: string): Promise<{
+    changed: string;
+}>;
+export interface ConversationSummary {
+    id: number;
+    type: "private" | "group" | "self";
+    /** A group conversation's name (its course group). */
+    name?: string;
+    members: {
+        userId: number;
+        fullName: string;
+    }[];
+    unread: number;
+    lastMessage?: {
+        fromUserId: number;
+        text: string;
+        time?: string;
+    };
+}
+/** The person's conversations, latest first, with their last message as text. */
+export declare function conversations(context: BrowserContext, siteUrl: string): Promise<ConversationSummary[]>;
+/** A conversation's members and messages, oldest first, as text. */
+export declare function conversation(context: BrowserContext, siteUrl: string, conversationId: number): Promise<{
+    id: number;
+    members: {
+        userId: number;
+        fullName: string;
+    }[];
+    messages: {
+        id: number;
+        fromUserId: number;
+        text: string;
+        time: string | undefined;
+    }[];
+}>;
+/** Sends a private message to a user, as the messaging drawer does; returns the message and its conversation. */
+export declare function sendMessage(context: BrowserContext, siteUrl: string, userId: number, text: string): Promise<{
+    changed: string;
+    messageId: number;
+    conversationId?: number;
+}>;

package/dist/moodle/messages.js

@@ -0,0 +1,80 @@
+import { callService, readPageConfig } from "./ajax.js";
+import { isoDate } from "./courses.js";
+import { htmlToTexts } from "./forum.js";
+import { decodeEntities } from "./text.js";
+/** Moodle didn't deliver a message. */
+export class MessageError extends Error {
+    name = "MessageError";
+}
+/** The person's notifications, newest first, only the unread ones when asked. */
+export async function notifications(context, siteUrl, { unreadOnly = false } = {}) {
+    const { notifications: found } = await callService(context, siteUrl, "message_popup_get_popup_notifications", { useridto: 0, limit: 0, offset: 0 });
+    return found
+        .filter((n) => !unreadOnly || !n.read)
+        .map((n) => ({
+        id: n.id,
+        subject: decodeEntities(n.subject),
+        text: decodeEntities(n.fullmessage || n.smallmessage).trim(),
+        fromUserId: n.useridfrom,
+        time: isoDate(n.timecreated),
+        read: n.read,
+        ...(n.contexturl ? { url: n.contexturl } : {}),
+        ...(n.component ? { component: n.component } : {}),
+        ...(n.eventtype ? { eventType: n.eventtype } : {}),
+    }));
+}
+/** Marks all the person's notifications read, as the popover's "Mark all as read" does; doing it twice changes nothing. */
+export async function markNotificationsRead(context, siteUrl) {
+    const { userId } = await readPageConfig(context, siteUrl);
+    await callService(context, siteUrl, "core_message_mark_all_notifications_as_read", { useridto: userId });
+    return { changed: "All notifications marked read." };
+}
+/** A conversation's types, by Moodle's MESSAGE_CONVERSATION_TYPE_* values. */
+const CONVERSATION_TYPES = { 1: "private", 2: "group", 3: "self" };
+/** The person's conversations, latest first, with their last message as text. */
+export async function conversations(context, siteUrl) {
+    const { userId } = await readPageConfig(context, siteUrl);
+    const { conversations: found } = await callService(context, siteUrl, "core_message_get_conversations", { userid: userId, limitfrom: 0, limitnum: 0 });
+    const texts = await htmlToTexts(context, found.map((c) => c.messages[0]?.text ?? ""));
+    return found.map((c, i) => {
+        const last = c.messages[0];
+        return {
+            id: c.id,
+            type: CONVERSATION_TYPES[c.type] ?? "private",
+            ...(c.name ? { name: decodeEntities(c.name) } : {}),
+            members: c.members.map((m) => ({ userId: m.id, fullName: m.fullname })),
+            unread: c.unreadcount ?? 0,
+            ...(last ? { lastMessage: { fromUserId: last.useridfrom, text: texts[i] ?? "", time: isoDate(last.timecreated) } } : {}),
+        };
+    });
+}
+/** A conversation's members and messages, oldest first, as text. */
+export async function conversation(context, siteUrl, conversationId) {
+    const { userId } = await readPageConfig(context, siteUrl);
+    const found = await callService(context, siteUrl, "core_message_get_conversation_messages", {
+        currentuserid: userId,
+        convid: conversationId,
+        limitfrom: 0,
+        limitnum: 0,
+        newest: false,
+    });
+    const texts = await htmlToTexts(context, found.messages.map((m) => m.text));
+    return {
+        id: found.id,
+        members: found.members.map((m) => ({ userId: m.id, fullName: m.fullname })),
+        messages: found.messages.map((m, i) => ({ id: m.id, fromUserId: m.useridfrom, text: texts[i] ?? "", time: isoDate(m.timecreated) })),
+    };
+}
+/** Sends a private message to a user, as the messaging drawer does; returns the message and its conversation. */
+export async function sendMessage(context, siteUrl, userId, text) {
+    if (text.replace(/<[^>]*>/g, "").replace(/&nbsp;/g, " ").trim() === "")
+        throw new MessageError("The message is empty: write something before sending it.");
+    const [sent] = await callService(context, siteUrl, "core_message_send_instant_messages", {
+        messages: [{ touserid: userId, text, textformat: 1 }],
+    });
+    // A refused message comes back with id -1 and Moodle's reason (blocked, not a contact…).
+    if (!sent || sent.msgid < 0)
+        throw new MessageError(`Moodle didn't send the message to user ${userId}: ${sent?.errormessage ?? "no reason given"}`);
+    return { changed: `Message ${sent.msgid} sent to user ${userId}.`, messageId: sent.msgid, ...(sent.conversationid ? { conversationId: sent.conversationid } : {}) };
+}
+//# sourceMappingURL=messages.js.map

package/dist/moodle/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/moodle/messages.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C,uCAAuC;AACvC,MAAM,OAAO,YAAa,SAAQ,KAAK;IAC5B,IAAI,GAAG,cAAc,CAAC;CAChC;AAgCD,iFAAiF;AACjF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAuB,EAAE,OAAe,EAAE,EAAE,UAAU,GAAG,KAAK,KAA+B,EAAE;IACjI,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,MAAM,WAAW,CAA0C,OAAO,EAAE,OAAO,EAAE,uCAAuC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;IAC7L,OAAO,KAAK;SACT,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;SACrC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACX,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC;QAClC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE;QAC5D,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC;QAC5B,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnD,CAAC,CAAC,CAAC;AACR,CAAC;AAED,2HAA2H;AAC3H,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,OAAuB,EAAE,OAAe;IAClF,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,6CAA6C,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IACzG,OAAO,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAC;AACvD,CAAC;AAED,8EAA8E;AAC9E,MAAM,kBAAkB,GAAiD,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;AAwBjH,iFAAiF;AACjF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAuB,EAAE,OAAe;IAC1E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,MAAM,WAAW,CAE/C,OAAO,EAAE,OAAO,EAAE,gCAAgC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;IACtG,MAAM,KAAK,GAAG,MAAM,WAAW,CAC7B,OAAO,EACP,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC,CAC5C,CAAC;IACF,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACxB,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO;YACL,EAAE,EAAE,CAAC,CAAC,EAAE;YACR,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,SAAS;YAC7C,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnD,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;YACvE,MAAM,EAAE,CAAC,CAAC,WAAW,IAAI,CAAC;YAC1B,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACzH,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,oEAAoE;AACpE,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAuB,EAAE,OAAe,EAAE,cAAsB;IACjG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,KAAK,GAAG,MAAM,WAAW,CAAiF,OAAO,EAAE,OAAO,EAAE,wCAAwC,EAAE;QAC1K,aAAa,EAAE,MAAM;QACrB,MAAM,EAAE,cAAc;QACtB,SAAS,EAAE,CAAC;QACZ,QAAQ,EAAE,CAAC;QACX,MAAM,EAAE,KAAK;KACd,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,MAAM,WAAW,CAC7B,OAAO,EACP,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAClC,CAAC;IACF,OAAO;QACL,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3E,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;KACrI,CAAC;AACJ,CAAC;AAED,iHAAiH;AACjH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAuB,EAAE,OAAe,EAAE,MAAc,EAAE,IAAY;IACtG,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,MAAM,IAAI,YAAY,CAAC,0DAA0D,CAAC,CAAC;IAC3J,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,WAAW,CAAsE,OAAO,EAAE,OAAO,EAAE,oCAAoC,EAAE;QAC5J,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;KACtD,CAAC,CAAC;IACH,yFAAyF;IACzF,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC;QAAE,MAAM,IAAI,YAAY,CAAC,0CAA0C,MAAM,KAAK,IAAI,EAAE,YAAY,IAAI,iBAAiB,EAAE,CAAC,CAAC;IACpJ,OAAO,EAAE,OAAO,EAAE,WAAW,IAAI,CAAC,KAAK,iBAAiB,MAAM,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;AACtK,CAAC"}

package/dist/moodle/overview.d.ts

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

package/dist/moodle/overview.js

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

package/dist/moodle/overview.js.map

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

package/dist/moodle/pace.d.ts

@@ -0,0 +1,4 @@
+/** How long a person would take to read `text`, in seconds. */
+export declare function readingSeconds(text: string): number;
+/** Waits `seconds`, calling `onProgress` every few seconds so clients keep waiting. */
+export declare function pause(seconds: number, onProgress?: (elapsedSeconds: number) => void): Promise<void>;

package/dist/moodle/pace.js

@@ -0,0 +1,19 @@
+// Reading at a person's pace (ADR-005): about 240 words a minute, bounded per page.
+const WORDS_PER_SECOND = 4;
+const MIN_SECONDS = 3;
+const MAX_SECONDS = 90;
+const PROGRESS_EVERY_MS = 5000;
+/** How long a person would take to read `text`, in seconds. */
+export function readingSeconds(text) {
+    const words = text.split(/\s+/).filter(Boolean).length;
+    return Math.min(MAX_SECONDS, Math.max(MIN_SECONDS, Math.round(words / WORDS_PER_SECOND)));
+}
+/** Waits `seconds`, calling `onProgress` every few seconds so clients keep waiting. */
+export async function pause(seconds, onProgress) {
+    const end = Date.now() + seconds * 1000;
+    while (Date.now() < end) {
+        await new Promise((resolve) => setTimeout(resolve, Math.min(PROGRESS_EVERY_MS, end - Date.now())));
+        onProgress?.(Math.round(seconds - (end - Date.now()) / 1000));
+    }
+}
+//# sourceMappingURL=pace.js.map

package/dist/moodle/pace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pace.js","sourceRoot":"","sources":["../../src/moodle/pace.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAC3B,MAAM,WAAW,GAAG,CAAC,CAAC;AACtB,MAAM,WAAW,GAAG,EAAE,CAAC;AACvB,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAE/B,+DAA+D;AAC/D,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IACvD,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,uFAAuF;AACvF,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAAe,EAAE,UAA6C;IACxF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,GAAG,IAAI,CAAC;IACxC,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QACnG,UAAU,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAChE,CAAC;AACH,CAAC"}

package/dist/moodle/participants.d.ts

@@ -0,0 +1,55 @@
+import type { BrowserContext, Page } from "playwright-core";
+export interface Participant {
+    userId: number;
+    fullName: string;
+    roles: {
+        id: number;
+        name: string;
+    }[];
+    groups: {
+        id: number;
+        name: string;
+    }[];
+}
+export interface CourseGroup {
+    id: number;
+    name: string;
+    /** The members' user ids. */
+    members: number[];
+}
+/** The person can't see the course's participants. */
+export declare class NoParticipantsError extends Error {
+    name: string;
+}
+/** The rows of a participants table fragment: user id and name, read by link and markup, in any language. */
+export declare function readParticipantRows(page: Page): Promise<{
+    userId: number;
+    fullName: string;
+}[]>;
+/**
+ * The roles and groups the participants page filters by in a course (its filters' options), as the
+ * person may use them: every group, or only their own in a course with separate groups. "No roles"
+ * and "no group" left out.
+ */
+export declare function participantFilters(context: BrowserContext, siteUrl: string, courseId: number): Promise<{
+    roles: {
+        id: number;
+        name: string;
+    }[];
+    groups: {
+        id: number;
+        name: string;
+    }[];
+}>;
+/** A course's groups the person can see, with their members' user ids. */
+export declare function groups(context: BrowserContext, siteUrl: string, courseId: number): Promise<CourseGroup[]>;
+/**
+ * A course's participants with their roles and groups, as the participants page lists them: only
+ * those with a role (its id), in a group, or (`inactiveSince`) who haven't accessed the course since
+ * that date, when asked. Each role and group is a filter of its own, so ids come in any language.
+ */
+export declare function participants(context: BrowserContext, siteUrl: string, courseId: number, { role, group, inactiveSince }?: {
+    role?: number;
+    group?: number;
+    inactiveSince?: Date;
+}): Promise<Participant[]>;