@falkenslab/moodle-driver 0.0.0-stage → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Falkenslab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,132 @@
-# Temporary Holding Version
+<div align="center">
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<img src="docs/static/img/logo.svg" alt="moodle-driver logo: a terminal prompt, >m_" width="112"/>
+
+# moodle-driver
+
+**Everything a person does in Moodle, from your Node.js code.**<br/>
+With their own login: no web services, no tokens, no admin.
+
+[![Documentation](https://img.shields.io/badge/docs-falkenslab.github.io-f97316?logo=docusaurus&logoColor=white)](https://falkenslab.github.io/moodle-driver/)
+[![npm](https://img.shields.io/npm/v/@falkenslab/moodle-driver?color=cb3837&logo=npm)](https://www.npmjs.com/package/@falkenslab/moodle-driver)
+![Node.js 20+](https://img.shields.io/badge/node-20%2B-339933?logo=node.js&logoColor=white)
+![TypeScript](https://img.shields.io/badge/types-included-3178c6?logo=typescript&logoColor=white)
+![Moodle 4.x and 5.x](https://img.shields.io/badge/Moodle-4.x%20%7C%205.x-f98012?logo=moodle&logoColor=white)
+[![License: MIT](https://img.shields.io/badge/license-MIT-16a34a)](LICENSE)
+
+<img src="docs/static/img/diagrams/at-a-glance.svg" alt="Your program calls moodle-driver, which works Moodle with the person's own login, and gets plain data back" width="900"/>
+
+</div>
+
+## ✨ In a few lines
+
+```ts
+import { createMoodle } from "@falkenslab/moodle-driver";
+
+await using moodle = createMoodle({ site: "https://campus.example.org/", profileDir: "/home/ada/.moodle-profile", headless: true, downloadBrowser: true });
+await moodle.logIn(); // 🔑 the first time a window opens and the person logs in; afterwards, nothing
+
+for (const course of await moodle.listCourses()) {
+  const { pending } = await moodle.pendingActivities(course.id);
+  console.log(`📚 ${course.fullname}: ${pending.length} things to do`);
+}
+```
+
+That's it: no API keys, nothing to ask the administrator. The browser closes by itself at the end of the block.
+
+## 🧰 What it can do
+
+<div align="center">
+<img src="docs/static/img/diagrams/what-it-can-do.svg" alt="As a student: agenda, content, assignments, quizzes, surveys, lessons, grades, forums. As a teacher: build courses, grade with rubrics, extensions and overrides, quiz results, question banks, gradebook, participants, completion, calendar. For your program: typed methods, a moodle command, errors with codes, any AJAX service, data categories, a fake Moodle for tests." width="900"/>
+</div>
+
+## 🚀 A taste
+
+**🎒 A student's week**, deadlines first:
+
+```ts
+for (const d of await moodle.deadlines({ days: 7 })) {
+  console.log(`${d.date.slice(0, 10)}  ${d.activity}${d.overdue ? "  ⚠️ overdue" : ""}`);
+}
+```
+
+**🧑‍🏫 A teacher grading** what's waiting, with feedback the student gets notified of:
+
+```ts
+for (const s of await moodle.assignmentSubmissions(35)) {
+  if (s.needsGrading) await moodle.gradeSubmission(35, s.userId, { grade: 8.5, feedback: "<p>Great work!</p>", notify: true });
+}
+```
+
+**🏗️ Building a course**: every write tells you what it did:
+
+```ts
+const { changed } = await moodle.createActivity({ courseId: 3, sectionId: 7, type: "page", name: "Loops", content: "<p>for, while…</p>" });
+console.log(changed); // Created page 42 "Loops" in section 2.
+```
+
+More, complete and commented: [📖 use-case examples](https://falkenslab.github.io/moodle-driver/examples).
+
+## 🖥️ Or straight from the terminal
+
+Every method is also a command of `moodle`, which comes with the package: no project, no code.
+
+```bash
+npm i -g @falkenslab/moodle-driver
+moodle login --site https://campus.example.org/   # 🔑 once: a window opens, you log in
+moodle list-courses
+moodle deadlines --days 7
+moodle grade-submission 35 7 --grade 8.5 --feedback "<p>Great work!</p>" --notify
+moodle my-grades 3 --json | jq '.[] | select(.grade) | .name'
+```
+
+Tables at a terminal, JSON for scripts, errors with their code and an exit status. `moodle help` lists every command, generated from the API so none is missing; `--allow own,course-content` refuses anything touching other people's data. See [the command line](https://falkenslab.github.io/moodle-driver/getting-started/command-line).
+
+## 💡 Why it's different
+
+- 🔑 **The person's own login.** They log in once in a window (SSO and two-factor included); the driver never sees a password.
+- 🚫 **No web services.** Many campuses don't enable them. The driver uses the same pages and AJAX services Moodle's own screens use: the services over plain HTTP with the person's session, the browser to log in, fill forms and read pages.
+- 🔐 **Moodle decides.** It can do what the person can do, and nothing more: every permission is Moodle's.
+- 🌍 **Any language.** Pages are read by structure (ids, data attributes, field names), never by their text.
+- 🐢 **At a person's pace** when acting as a student, so Moodle's logs and completion look like a person's; or 🐇 fast when time matters.
+- 🛡️ **Safe to hand to an agent.** Every function declares the data it touches (own, course content, others' work, communication…), so a program can allow only some.
+- 📦 **Plain data, typed.** JSON results, ISO dates, errors with stable codes, TypeScript types included.
+- 🖥️ **A library and a command.** The same operations from your code or from a terminal.
+
+## 📦 Install
+
+```bash
+npm install @falkenslab/moodle-driver playwright-core   # the library, in your project
+npm i -g @falkenslab/moodle-driver                      # the moodle command, everywhere
+```
+
+You need Node.js 20+, a Moodle 4.x or 5.x site, and Edge or Chrome (or let it download Chromium). See [installation](https://falkenslab.github.io/moodle-driver/getting-started/installation).
+
+## 📚 Documentation
+
+| | |
+| --- | --- |
+| 🏁 [Getting started](https://falkenslab.github.io/moodle-driver/getting-started/installation) | Install, log in, your first program |
+| 💡 [Concepts](https://falkenslab.github.io/moodle-driver/concepts/how-it-works) | How it works, the browser, errors, pace, data categories |
+| 🖥️ [Command line](https://falkenslab.github.io/moodle-driver/getting-started/command-line) | The `moodle` command: log in, run any operation, script it |
+| 🗺️ [Moodle areas](https://falkenslab.github.io/moodle-driver/areas/courses) | Every function, by area: courses, quizzes, grading, forums… |
+| 📖 [Examples](https://falkenslab.github.io/moodle-driver/examples) | Complete programs for real tasks, commented |
+| 📘 [Glossary](https://falkenslab.github.io/moodle-driver/reference/glossary) | Moodle's terms, explained for programmers |
+| ⌨️ [Commands](https://falkenslab.github.io/moodle-driver/reference/commands) | Every command, its arguments and options |
+| 🔎 [API reference](https://falkenslab.github.io/moodle-driver/api) | Generated from the code |
+
+## 🛠️ Development
+
+```bash
+npm install
+npm run typecheck && npm run lint
+npm run test:docker    # the tests open browsers: always in Docker, never on the desktop
+npm run build          # dist/, with declarations
+npm run docs:check     # every example in the docs compiles against the code
+```
+
+The design lives in [`.minispec/`](.minispec/) (start with `core/project.md` and the decisions). Extracted from moodle-mcp, its first consumer.
+
+## 📄 License
+
+MIT © Falkenslab

package/dist/areas/activities/build.d.ts

@@ -0,0 +1,98 @@
+import type { BrowserContext, Page } from "playwright-core";
+import { type FieldValue } from "../../core/forms.js";
+import { type CourseSection } from "../courses/structure.js";
+import { MoodleError } from "../../core/errors.js";
+/** "stealth": hidden from the course page but available by link, where the site allows it. */
+export declare const ACTIVITY_VISIBILITIES: readonly ["shown", "hidden", "stealth"];
+export type ActivityVisibility = (typeof ACTIVITY_VISIBILITIES)[number];
+/** The common inputs of an activity's form; anything else goes in `settings` by its form field name. */
+export interface ActivityFields {
+    name?: string;
+    /** The description (HTML), shown on the activity's page. */
+    description?: string;
+    /** A page's content, or a label's text (HTML). */
+    content?: string;
+    /** A URL resource's target. */
+    url?: string;
+    visibility?: ActivityVisibility;
+    settings?: Record<string, FieldValue>;
+}
+/** What a change did, its new id when it created something, and the course afterwards. */
+export interface CourseChange {
+    changed: string;
+    activityId?: number;
+    sectionId?: number;
+    url?: string;
+    sections: CourseSection[];
+}
+/**
+ * Creates an activity or resource of any type at the end of a section, through Moodle's own form,
+ * hidden from students unless `visibility` says otherwise. `files` are local paths uploaded to a file
+ * resource or folder; a SCORM (`type: "scorm"`) takes the first as its package.
+ */
+export declare function createActivity(context: BrowserContext, siteUrl: string, input: ActivityFields & {
+    courseId: number;
+    sectionId: number;
+    type: string;
+    files?: string[];
+}): Promise<CourseChange>;
+/** Changes an existing activity through its form: only what's given changes; files stay as they are. */
+export declare function updateActivity(context: BrowserContext, siteUrl: string, activityId: number, input: ActivityFields): Promise<CourseChange>;
+/** Renames, shows or hides, or moves an activity (to a section's end, or before another one). */
+export declare function editActivity(context: BrowserContext, siteUrl: string, courseId: number, activityId: number, { name, visibility, sectionId, beforeActivityId }: {
+    name?: string;
+    visibility?: ActivityVisibility;
+    sectionId?: number;
+    beforeActivityId?: number;
+}): Promise<CourseChange>;
+/** Duplicates an activity as the course page's "Duplicate" does (right after it, named with "(copy)"); gives the copy's id and the course afterwards. */
+export declare function duplicateActivity(context: BrowserContext, siteUrl: string, courseId: number, activityId: number): Promise<CourseChange>;
+/** Deletes an activity, with its participants' data (submissions, posts, attempts); gives the course afterwards. */
+export declare function deleteActivity(context: BrowserContext, siteUrl: string, courseId: number, activityId: number): Promise<CourseChange>;
+/** Adds a section after another one (at the end without it), named when a name is given. */
+export declare function addSection(context: BrowserContext, siteUrl: string, courseId: number, { name, afterSectionId }?: {
+    name?: string;
+    afterSectionId?: number;
+}): Promise<CourseChange>;
+/** Renames, shows or hides, or moves a section after another one. */
+export declare function editSection(context: BrowserContext, siteUrl: string, courseId: number, sectionId: number, { name, visible, afterSectionId }: {
+    name?: string;
+    visible?: boolean;
+    afterSectionId?: number;
+}): Promise<CourseChange>;
+/** Deletes a section and every activity in it, with their participants' data. */
+export declare function deleteSection(context: BrowserContext, siteUrl: string, courseId: number, sectionId: number): Promise<CourseChange>;
+/** One field of a Moodle form, as it is now: its name (what `settings` takes), label, value and options. */
+export interface FormField {
+    name: string;
+    type: "text" | "textarea" | "select" | "checkbox" | "radio" | "number" | "date" | "other";
+    label?: string;
+    /** Text, the selected option (several for a multiple select), the checked radio's value. */
+    value?: string | string[];
+    checked?: boolean;
+    options?: {
+        value: string;
+        label: string;
+    }[];
+    /** Disabled until another field enables it; Moodle doesn't save it as it is. */
+    disabled?: boolean;
+}
+/** The fields of a Moodle form in `page`, internal ones (sesskey, ids, buttons) left out, editors' HTML included. */
+export declare function readFormFields(page: Page): Promise<FormField[]>;
+/** Nobody can see that activity's settings: not an activity, or not the person's to edit. */
+export declare class ActivitySettingsError extends MoodleError {
+    name: string;
+    constructor(message: string);
+}
+/**
+ * An activity's settings as its form holds them, without submitting it: its module, name and
+ * description, and every field by the name `updateActivity` takes in `settings`. Teachers only.
+ */
+export declare function activitySettings(context: BrowserContext, siteUrl: string, activityId: number): Promise<{
+    id: number;
+    module: string;
+    courseId: number;
+    name: string;
+    description: string;
+    fields: FormField[];
+}>;

package/dist/areas/activities/build.js

@@ -0,0 +1,248 @@
+import { courseState } from "../courses/state.js";
+import { editCourse, renameActivity, renameSection } from "../../core/editor.js";
+import { checkLocalFiles } from "../../core/files.js";
+import { formValue, openForm, setFields, submitForm, uploadToDraft } from "../../core/forms.js";
+import { inPage } from "../../core/inPage.js";
+import { moodleErrorMessage, openSitePage } from "../../core/session.js";
+import { structureOf } from "../courses/structure.js";
+import { MoodleError } from "../../core/errors.js";
+/** "stealth": hidden from the course page but available by link, where the site allows it. */
+export const ACTIVITY_VISIBILITIES = ["shown", "hidden", "stealth"];
+const FORM_VISIBILITY = { shown: 1, hidden: 0, stealth: -1 };
+const VISIBILITY_ACTIONS = { shown: "cm_show", hidden: "cm_hide", stealth: "cm_stealth" };
+/** The form values the common inputs stand for, given the activity's type. */
+function fieldsFor(type, input) {
+    const values = {};
+    if (input.name !== undefined)
+        values.name = input.name;
+    if (input.description !== undefined)
+        values["introeditor[text]"] = input.description;
+    if (input.content !== undefined) {
+        // A label's text is its description field; a page has its own content editor.
+        if (type === "label")
+            values["introeditor[text]"] = input.content;
+        else if (type === "page")
+            values["page[text]"] = input.content;
+        else
+            throw new MoodleError(`content is for pages and labels; for a ${type}, use description or settings.`, "invalid-input");
+    }
+    if (input.url !== undefined)
+        values.externalurl = input.url;
+    if (input.visibility !== undefined)
+        values.visible = FORM_VISIBILITY[input.visibility];
+    return { ...values, ...input.settings };
+}
+async function afterChange(context, siteUrl, courseId, changed, extra = {}) {
+    return { changed, ...extra, sections: structureOf(await courseState(context, siteUrl, courseId)) };
+}
+/**
+ * Creates an activity or resource of any type at the end of a section, through Moodle's own form,
+ * hidden from students unless `visibility` says otherwise. `files` are local paths uploaded to a file
+ * resource or folder; a SCORM (`type: "scorm"`) takes the first as its package.
+ */
+export async function createActivity(context, siteUrl, input) {
+    if (input.files)
+        await checkLocalFiles(input.files);
+    const before = await courseState(context, siteUrl, input.courseId);
+    const target = before.section.find((s) => Number(s.id) === input.sectionId);
+    if (!target)
+        throw new MoodleError(`Course ${input.courseId} has no section ${input.sectionId}. Take its id from the course structure.`, "not-found");
+    const page = await openForm(context, siteUrl, `course/modedit.php?add=${input.type}&course=${input.courseId}&section=${target.number}&return=0`);
+    try {
+        if (input.files && input.files.length > 0) {
+            // A SCORM takes one package, in a field of its own.
+            const scorm = input.type === "scorm";
+            const draft = await formValue(page, scorm ? "packagefile" : "files");
+            if (!draft)
+                throw new MoodleError(`A ${input.type} takes no files in its form.`, "not-available");
+            await uploadToDraft(page, draft, scorm ? input.files.slice(0, 1) : input.files);
+        }
+        // Hidden unless asked: a teacher publishes after checking.
+        await setFields(page, fieldsFor(input.type, { ...input, visibility: input.visibility ?? "hidden" }));
+        await submitForm(page, "submitbutton2");
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+    const after = await courseState(context, siteUrl, input.courseId);
+    const created = after.cm.find((cm) => !before.cm.some((old) => old.id === cm.id));
+    return {
+        changed: created ? `Created ${input.type} ${created.id} "${created.name}" in section ${target.number}.` : `The form was saved, but no new activity appears in course ${input.courseId}.`,
+        activityId: created ? Number(created.id) : undefined,
+        url: created?.url,
+        sections: structureOf(after),
+    };
+}
+/** Changes an existing activity through its form: only what's given changes; files stay as they are. */
+export async function updateActivity(context, siteUrl, activityId, input) {
+    const page = await openForm(context, siteUrl, `course/modedit.php?update=${activityId}&return=0`);
+    let courseId;
+    try {
+        courseId = Number(await formValue(page, "course"));
+        const type = (await formValue(page, "modulename")) ?? "";
+        await setFields(page, fieldsFor(type, input));
+        await submitForm(page, "submitbutton2");
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+    const after = await courseState(context, siteUrl, courseId);
+    const cm = after.cm.find((c) => Number(c.id) === activityId);
+    return { changed: `Updated activity ${activityId}${cm ? ` "${cm.name}"` : ""}.`, activityId: activityId, url: cm?.url, sections: structureOf(after) };
+}
+/** Renames, shows or hides, or moves an activity (to a section's end, or before another one). */
+export async function editActivity(context, siteUrl, courseId, activityId, { name, visibility, sectionId, beforeActivityId }) {
+    const done = [];
+    if (name !== undefined) {
+        await renameActivity(context, siteUrl, activityId, name);
+        done.push(`renamed to "${name}"`);
+    }
+    if (visibility !== undefined) {
+        await editCourse(context, siteUrl, courseId, VISIBILITY_ACTIONS[visibility], [activityId]);
+        done.push(`made ${visibility}`);
+    }
+    if (sectionId !== undefined || beforeActivityId !== undefined) {
+        await editCourse(context, siteUrl, courseId, "cm_move", [activityId], { sectionId, activityId: beforeActivityId });
+        done.push(beforeActivityId !== undefined ? `moved before activity ${beforeActivityId}` : `moved to the end of section ${sectionId}`);
+    }
+    return afterChange(context, siteUrl, courseId, done.length > 0 ? `Activity ${activityId} ${done.join(", ")}.` : "Nothing to change.");
+}
+/** Duplicates an activity as the course page's "Duplicate" does (right after it, named with "(copy)"); gives the copy's id and the course afterwards. */
+export async function duplicateActivity(context, siteUrl, courseId, activityId) {
+    const before = new Set((await courseState(context, siteUrl, courseId)).cm.map((cm) => cm.id));
+    await editCourse(context, siteUrl, courseId, "cm_duplicate", [activityId]);
+    const copy = (await courseState(context, siteUrl, courseId)).cm.find((cm) => !before.has(cm.id));
+    return afterChange(context, siteUrl, courseId, `Activity ${activityId} duplicated${copy ? ` as ${copy.id}` : ""}.`, { activityId: copy ? Number(copy.id) : undefined });
+}
+/** Deletes an activity, with its participants' data (submissions, posts, attempts); gives the course afterwards. */
+export async function deleteActivity(context, siteUrl, courseId, activityId) {
+    await editCourse(context, siteUrl, courseId, "cm_delete", [activityId]);
+    return afterChange(context, siteUrl, courseId, `Activity ${activityId} deleted.`);
+}
+/** Adds a section after another one (at the end without it), named when a name is given. */
+export async function addSection(context, siteUrl, courseId, { name, afterSectionId } = {}) {
+    const before = new Set((await courseState(context, siteUrl, courseId)).section.map((s) => s.id));
+    await editCourse(context, siteUrl, courseId, "section_add", [], { sectionId: afterSectionId });
+    const added = (await courseState(context, siteUrl, courseId)).section.find((s) => !before.has(s.id));
+    if (added && name !== undefined)
+        await renameSection(context, siteUrl, courseId, Number(added.id), name);
+    return afterChange(context, siteUrl, courseId, `Section ${added?.id ?? "?"} added${name !== undefined ? ` as "${name}"` : ""}.`, { sectionId: added ? Number(added.id) : undefined });
+}
+/** Renames, shows or hides, or moves a section after another one. */
+export async function editSection(context, siteUrl, courseId, sectionId, { name, visible, afterSectionId }) {
+    const done = [];
+    if (name !== undefined) {
+        await renameSection(context, siteUrl, courseId, sectionId, name);
+        done.push(`renamed to "${name}"`);
+    }
+    if (visible !== undefined) {
+        await editCourse(context, siteUrl, courseId, visible ? "section_show" : "section_hide", [sectionId]);
+        done.push(visible ? "shown" : "hidden");
+    }
+    if (afterSectionId !== undefined) {
+        await editCourse(context, siteUrl, courseId, "section_move_after", [sectionId], { sectionId: afterSectionId });
+        done.push(`moved after section ${afterSectionId}`);
+    }
+    return afterChange(context, siteUrl, courseId, done.length > 0 ? `Section ${sectionId} ${done.join(", ")}.` : "Nothing to change.");
+}
+/** Deletes a section and every activity in it, with their participants' data. */
+export async function deleteSection(context, siteUrl, courseId, sectionId) {
+    await editCourse(context, siteUrl, courseId, "section_delete", [sectionId]);
+    return afterChange(context, siteUrl, courseId, `Section ${sectionId} deleted, with its activities.`);
+}
+/** The fields of a Moodle form in `page`, internal ones (sesskey, ids, buttons) left out, editors' HTML included. */
+export function readFormFields(page) {
+    return inPage(page, () => {
+        const doc = globalThis.document;
+        const clean = (s) => (s ?? "").replace(/\s+/g, " ").trim();
+        // A field's label: its own <label for>, or its row's (a date selector's parts, a radio group).
+        const labelOf = (field) => {
+            const own = field.id ? doc.querySelector(`label[for="${field.id}"]`) : null;
+            const row = field.closest(".fitem")?.querySelector(".col-form-label label, .col-form-label p, legend");
+            return clean(own?.textContent) || clean(row?.textContent) || undefined;
+        };
+        const fields = [];
+        const internal = /^(sesskey|_qf__|mform_isexpanded_|mform_showmore_|course$|coursemodule$|section$|module$|modulename$|instance$|add$|update$|return$|sr$|beforemod$)/;
+        for (const field of Array.from(doc.querySelectorAll("form.mform [name]"))) {
+            const name = field.name;
+            if (!name || internal.test(name) || ["hidden", "submit", "button", "fieldset"].includes(field.type) || field.tagName === "FIELDSET")
+                continue;
+            if (field.type === "radio") {
+                let group = fields.find((f) => f.name === name);
+                if (!group) {
+                    group = { name, type: "radio", label: clean(field.closest(".fitem")?.querySelector(".col-form-label, legend")?.textContent) || undefined, options: [] };
+                    fields.push(group);
+                }
+                group.options.push({ value: field.value, label: clean((doc.querySelector(`label[for="${field.id}"]`) ?? field.closest("label"))?.textContent) || field.value });
+                if (field.checked)
+                    group.value = field.value;
+            }
+            else if (field.type === "checkbox") {
+                fields.push({ name, type: "checkbox", label: labelOf(field), value: field.value, checked: field.checked });
+            }
+            else if (field.tagName === "SELECT") {
+                const options = Array.from(field.options);
+                const selected = options.filter((o) => o.selected).map((o) => o.value);
+                // A date selector's parts (duedate[day]…) are numbers, named by their row ("Due date (day)").
+                const part = /\[(day|month|year|hour|minute)\]$/.exec(name)?.[1];
+                if (part) {
+                    // The group's label is id_<group>_label (id_duedate_label for duedate[day]).
+                    const row = clean(doc.querySelector(`#id_${name.slice(0, name.indexOf("["))}_label`)?.textContent);
+                    fields.push({ name, type: "date", label: row ? `${row} (${part})` : part, value: selected[0] });
+                }
+                else {
+                    fields.push({ name, type: "select", label: labelOf(field), value: field.multiple ? selected : selected[0], options: options.map((o) => ({ value: o.value, label: clean(o.text) })) });
+                }
+            }
+            else {
+                const type = field.tagName === "TEXTAREA" ? "textarea" : field.type === "number" ? "number" : field.type === "text" || field.type === "url" || field.type === "email" ? "text" : "other";
+                fields.push({ name, type, label: labelOf(field), value: field.value });
+            }
+        }
+        // Moodle disables fields until another enables them (a date until its "enable", a maximum grade until rescaling is chosen).
+        for (const f of fields) {
+            const elements = Array.from(doc.querySelectorAll(`form.mform [name="${f.name}"]`)).filter((e) => e.type !== "hidden");
+            if (elements.length > 0 && elements.every((e) => e.disabled))
+                f.disabled = true;
+            // No label, no key: plain data for the program.
+            for (const key of Object.keys(f))
+                if (f[key] === undefined)
+                    delete f[key];
+        }
+        return fields;
+    }, null);
+}
+/** Nobody can see that activity's settings: not an activity, or not the person's to edit. */
+export class ActivitySettingsError extends MoodleError {
+    name = "ActivitySettingsError";
+    constructor(message) {
+        super(message, "activity-settings");
+    }
+}
+/**
+ * An activity's settings as its form holds them, without submitting it: its module, name and
+ * description, and every field by the name `updateActivity` takes in `settings`. Teachers only.
+ */
+export async function activitySettings(context, siteUrl, activityId) {
+    const page = await openSitePage(context, siteUrl, `course/modedit.php?update=${activityId}&return=0`);
+    try {
+        if ((await page.locator("form.mform").count()) === 0) {
+            throw new ActivitySettingsError(`You can't see activity ${activityId}'s settings: ${(await moodleErrorMessage(page)) ?? "it doesn't exist, or you can't edit it"}`);
+        }
+        await page.waitForLoadState("load");
+        const fields = await readFormFields(page);
+        const value = (name) => fields.find((f) => f.name === name)?.value;
+        return {
+            id: activityId,
+            module: (await formValue(page, "modulename")) ?? "",
+            courseId: Number(await formValue(page, "course")),
+            name: value("name") ?? "",
+            description: value("introeditor[text]") ?? "",
+            fields,
+        };
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+}
+//# sourceMappingURL=build.js.map

package/dist/areas/activities/build.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.js","sourceRoot":"","sources":["../../../src/areas/activities/build.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACjF,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,kBAAkB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAE,WAAW,EAAsB,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,8FAA8F;AAC9F,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AAG7E,MAAM,eAAe,GAAuC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC;AACjG,MAAM,kBAAkB,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAW,CAAC;AAwBnG,8EAA8E;AAC9E,SAAS,SAAS,CAAC,IAAY,EAAE,KAAqB;IACpD,MAAM,MAAM,GAA+B,EAAE,CAAC;IAC9C,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACvD,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS;QAAE,MAAM,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC;IACrF,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChC,8EAA8E;QAC9E,IAAI,IAAI,KAAK,OAAO;YAAE,MAAM,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;aAC7D,IAAI,IAAI,KAAK,MAAM;YAAE,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC;;YAC1D,MAAM,IAAI,WAAW,CAAC,0CAA0C,IAAI,gCAAgC,EAAE,eAAe,CAAC,CAAC;IAC9H,CAAC;IACD,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS;QAAE,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC;IAC5D,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS;QAAE,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACvF,OAAO,EAAE,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;AAC1C,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,OAAe,EAAE,QAA+B,EAAE;IACvI,OAAO,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC;AACrG,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAAuB,EACvB,OAAe,EACf,KAA+F;IAE/F,IAAI,KAAK,CAAC,KAAK;QAAE,MAAM,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACnE,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC;IAC5E,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,WAAW,CAAC,UAAU,KAAK,CAAC,QAAQ,mBAAmB,KAAK,CAAC,SAAS,0CAA0C,EAAE,WAAW,CAAC,CAAC;IAEtJ,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,0BAA0B,KAAK,CAAC,IAAI,WAAW,KAAK,CAAC,QAAQ,YAAY,MAAM,CAAC,MAAM,WAAW,CAAC,CAAC;IACjJ,IAAI,CAAC;QACH,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1C,oDAAoD;YACpD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC;YACrC,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YACrE,IAAI,CAAC,KAAK;gBAAE,MAAM,IAAI,WAAW,CAAC,KAAK,KAAK,CAAC,IAAI,8BAA8B,EAAE,eAAe,CAAC,CAAC;YAClG,MAAM,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClF,CAAC;QACD,2DAA2D;QAC3D,MAAM,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;QACrG,MAAM,UAAU,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAC1C,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClE,MAAM,OAAO,GAAG,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAClF,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,IAAI,IAAI,OAAO,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,gBAAgB,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,6DAA6D,KAAK,CAAC,QAAQ,GAAG;QACxL,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;QACpD,GAAG,EAAE,OAAO,EAAE,GAAG;QACjB,QAAQ,EAAE,WAAW,CAAC,KAAK,CAAC;KAC7B,CAAC;AACJ,CAAC;AAED,wGAAwG;AACxG,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAuB,EAAE,OAAe,EAAE,UAAkB,EAAE,KAAqB;IACtH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,6BAA6B,UAAU,WAAW,CAAC,CAAC;IAClG,IAAI,QAAgB,CAAC;IACrB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,CAAC,MAAM,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;QACnD,MAAM,IAAI,GAAG,CAAC,MAAM,SAAS,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC;QACzD,MAAM,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC9C,MAAM,UAAU,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAC1C,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5D,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,UAAU,CAAC,CAAC;IAC7D,OAAO,EAAE,OAAO,EAAE,oBAAoB,UAAU,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;AACxJ,CAAC;AAED,iGAAiG;AACjG,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,OAAuB,EACvB,OAAe,EACf,QAAgB,EAChB,UAAkB,EAClB,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAqG;IAEpJ,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,GAAG,CAAC,CAAC;IACpC,CAAC;IACD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3F,IAAI,CAAC,IAAI,CAAC,QAAQ,UAAU,EAAE,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,SAAS,KAAK,SAAS,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QAC9D,MAAM,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,gBAAgB,EAAE,CAAC,CAAC;QACnH,IAAI,CAAC,IAAI,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,yBAAyB,gBAAgB,EAAE,CAAC,CAAC,CAAC,+BAA+B,SAAS,EAAE,CAAC,CAAC;IACvI,CAAC;IACD,OAAO,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC;AACxI,CAAC;AAED,yJAAyJ;AACzJ,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,UAAkB;IACpH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9F,MAAM,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3E,MAAM,IAAI,GAAG,CAAC,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACjG,OAAO,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,UAAU,cAAc,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;AAC1K,CAAC;AAED,oHAAoH;AACpH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,UAAkB;IACjH,MAAM,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IACxE,OAAO,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,UAAU,WAAW,CAAC,CAAC;AACpF,CAAC;AAED,4FAA4F;AAC5F,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,EAAE,IAAI,EAAE,cAAc,KAAiD,EAAE;IACpK,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACjG,MAAM,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;IAC/F,MAAM,KAAK,GAAG,CAAC,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrG,IAAI,KAAK,IAAI,IAAI,KAAK,SAAS;QAAE,MAAM,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IACzG,OAAO,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,KAAK,EAAE,EAAE,IAAI,GAAG,SAAS,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;AACxL,CAAC;AAED,qEAAqE;AACrE,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAAuB,EACvB,OAAe,EACf,QAAgB,EAChB,SAAiB,EACjB,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAiE;IAEhG,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QACjE,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,GAAG,CAAC,CAAC;IACpC,CAAC;IACD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QACrG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IACD,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;QAC/G,IAAI,CAAC,IAAI,CAAC,uBAAuB,cAAc,EAAE,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC;AACtI,CAAC;AAED,iFAAiF;AACjF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,SAAiB;IAC/G,MAAM,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5E,OAAO,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,SAAS,gCAAgC,CAAC,CAAC;AACvG,CAAC;AAeD,qHAAqH;AACrH,MAAM,UAAU,cAAc,CAAC,IAAU;IACvC,OAAO,MAAM,CACX,IAAI,EACJ,GAAG,EAAE;QAgBH,MAAM,GAAG,GAAI,UAA0C,CAAC,QAAQ,CAAC;QACjE,MAAM,KAAK,GAAG,CAAC,CAA4B,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QACtF,+FAA+F;QAC/F,MAAM,OAAO,GAAG,CAAC,KAAS,EAAE,EAAE;YAC5B,MAAM,GAAG,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,cAAc,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC5E,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,kDAAkD,CAAC,CAAC;YACvG,OAAO,KAAK,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,SAAS,CAAC;QACzE,CAAC,CAAC;QACF,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,qJAAqJ,CAAC;QACvK,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,EAAE,CAAC;YAC1E,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YACxB,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,KAAK,UAAU;gBAAE,SAAS;YAC9I,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBAC3B,IAAI,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;gBAChD,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,KAAK,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,yBAAyB,CAAC,EAAE,WAAW,CAAC,IAAI,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;oBACxJ,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACrB,CAAC;gBACD,KAAK,CAAC,OAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,cAAc,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;gBACjK,IAAI,KAAK,CAAC,OAAO;oBAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YAC/C,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC7G,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACtC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;gBACvE,8FAA8F;gBAC9F,MAAM,IAAI,GAAG,mCAAmC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACjE,IAAI,IAAI,EAAE,CAAC;oBACT,6EAA6E;oBAC7E,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,CAAC;oBACnG,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBAClG,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;gBACxL,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;gBACzL,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;QACD,4HAA4H;QAC5H,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;YACtH,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAAE,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC;YAChF,gDAAgD;YAChD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAwB;gBAAE,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,SAAS;oBAAE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;QACnG,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,EACD,IAAI,CACL,CAAC;AACJ,CAAC;AAED,6FAA6F;AAC7F,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IAC3C,IAAI,GAAG,uBAAuB,CAAC;IACxC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;IACtC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAuB,EAAE,OAAe,EAAE,UAAkB;IACjG,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,6BAA6B,UAAU,WAAW,CAAC,CAAC;IACtG,IAAI,CAAC;QACH,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,qBAAqB,CAAC,0BAA0B,UAAU,gBAAgB,CAAC,MAAM,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,wCAAwC,EAAE,CAAC,CAAC;QACtK,CAAC;QACD,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,KAA2B,CAAC;QACjG,OAAO;YACL,EAAE,EAAE,UAAU;YACd,MAAM,EAAE,CAAC,MAAM,SAAS,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,IAAI,EAAE;YACnD,QAAQ,EAAE,MAAM,CAAC,MAAM,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACjD,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE;YACzB,WAAW,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,EAAE;YAC7C,MAAM;SACP,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC"}

package/dist/areas/activities/content.d.ts

@@ -0,0 +1,53 @@
+import type { BrowserContext } from "playwright-core";
+import type { Trail } from "../../options.js";
+import { type MediaItem } from "../../core/text.js";
+import { MoodleError } from "../../core/errors.js";
+export declare const CONTENT_TYPES: readonly ["page", "book", "label", "url", "resource", "folder"];
+export type ContentType = (typeof CONTENT_TYPES)[number];
+/** The activity isn't of the given type, or the person can't view it. */
+export declare class NotViewableError extends MoodleError {
+    name: string;
+    constructor(message: string);
+}
+export interface ActivityContent {
+    activity: {
+        id: number;
+        type: ContentType;
+    };
+    /** Page and label content, as plain text with paragraphs and lists kept. */
+    text?: string;
+    /** A book's chapters, in order. */
+    chapters?: {
+        title: string;
+        text: string;
+    }[];
+    /** Videos, audio and players in a page's, label's or book's content. */
+    media?: MediaItem[];
+    /** A URL resource's target. */
+    url?: string;
+    /** A file resource's or a folder's files. */
+    files?: {
+        name: string;
+        url: string;
+    }[];
+    trail: Trail;
+    /** With the realistic trail, the time spent reading. */
+    readingSeconds?: number;
+}
+/**
+ * Reads a page's or label's text, a book's chapters, a URL resource's target, or a file resource's
+ * or folder's files. With the realistic trail, page by page at a reader's pace, calling `onProgress`
+ * with the seconds read so far while it pauses. Takes an activity as the course structure gives it
+ * (`{ id, type }`), or its id and module.
+ */
+export declare function activityContent(context: BrowserContext, siteUrl: string, activity: {
+    id: number;
+    type: string;
+}, options?: ContentOptions): Promise<ActivityContent>;
+export declare function activityContent(context: BrowserContext, siteUrl: string, activityId: number, type: ContentType, options?: ContentOptions): Promise<ActivityContent>;
+/** How `activityContent` reads: at a person's pace (`realistic`, the default) or at once. */
+export interface ContentOptions {
+    trail?: Trail;
+    /** While pausing on the realistic trail, the seconds read so far. */
+    onProgress?: (secondsRead: number) => void;
+}