@falkenslab/moodle-driver 0.0.0-stage → 0.4.0

package/dist/cli/spec.js

@@ -0,0 +1,4 @@
+// The shape of the command table the `moodle` command is built from (ADR-012): one command per method
+// of the Moodle object, generated from its types by scripts/generate-cli-commands.mjs.
+export {};
+//# sourceMappingURL=spec.js.map

package/dist/cli/spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec.js","sourceRoot":"","sources":["../../src/cli/spec.ts"],"names":[],"mappings":"AAAA,sGAAsG;AACtG,uFAAuF"}

package/dist/client.d.ts

@@ -0,0 +1,224 @@
+import type { BrowserContext, Page } from "playwright-core";
+import { type BrowserManager } from "./browser/manager.js";
+import { type BrowserOptions, type Trail } from "./options.js";
+import { activitySettings, addSection, createActivity, deleteActivity, deleteSection, duplicateActivity, editActivity, editSection, updateActivity } from "./areas/activities/build.js";
+import { createEvent, deleteEvent, upcomingEvents } from "./areas/calendar/calendar.js";
+import { answerChoice, getChoice } from "./areas/surveys/choice.js";
+import { completionReport, overrideCompletion, setCompletion } from "./areas/completion/completion.js";
+import { type ActivityContent, type ContentType } from "./areas/activities/content.js";
+import { listCourses, updateCourse } from "./areas/courses/list.js";
+import { type DownloadedFile } from "./core/files.js";
+import { openForm } from "./core/forms.js";
+import { discussion, forumDiscussions, replyToPost, setDiscussionState, startDiscussion } from "./areas/forums/posts.js";
+import { addGradeCategory, gradebookSetup, graderReport, updateGradeItem } from "./areas/grades/gradebook.js";
+import { myGrades } from "./areas/grades/user-report.js";
+import { assignmentSubmissions, gradeSubmission, grantExtension, rubric } from "./areas/assignments/grading.js";
+import { h5pActivity } from "./areas/h5p/h5p.js";
+import { scorm, type OpenedScorm } from "./areas/scorm/scorm.js";
+import { answerLessonPage, lessonPage, type LessonPage } from "./areas/lessons/lessons.js";
+import { type LoginResult } from "./core/login.js";
+import { conversation, conversations, markNotificationsRead, notifications, sendMessage } from "./areas/messages/messages.js";
+import { activitiesOverview, courseUpdates, deadlines } from "./areas/courses/overview.js";
+import { groups, participantFilters, participants } from "./areas/participants/participants.js";
+import { createQuestion, importQuestions, questionBanks, questions } from "./areas/questions/banks.js";
+import { answerQuizQuestions, finishQuizAttempt, quizInfo, readAttempt, readReview, setQuizOverride, startQuizAttempt, type Question } from "./areas/quizzes/attempts.js";
+import { quizResults } from "./areas/quizzes/results.js";
+import { addQuestionsToQuiz, quizStructure } from "./areas/quizzes/structure.js";
+import { logOut, openSitePage } from "./core/session.js";
+import { courseActivityTypes, publicSiteInfo } from "./areas/site/info.js";
+import { courseStructure, listAssignments, pendingActivities } from "./areas/courses/structure.js";
+import { saveSubmission, studentAssignment, submitForGrading } from "./areas/assignments/student.js";
+import { getSurvey, submitSurvey } from "./areas/surveys/surveys.js";
+import { courseAbilities, courseRoles, siteName, userById, whoAmI } from "./areas/site/users.js";
+/**
+ * The functions that take the browser context and the site first, of the high-level API: each becomes
+ * a method of the same name without those two parameters. The pieces they're built from (an
+ * assignment's ids, its grading panel, a quiz attempt's steps…) stay functions only; the ones that
+ * use the object's defaults (`trail`, `downloadDir`…) and `callService`, generic, are bound by hand.
+ */
+declare const SITE_FUNCTIONS: {
+    activitiesOverview: typeof activitiesOverview;
+    activitySettings: typeof activitySettings;
+    addGradeCategory: typeof addGradeCategory;
+    addQuestionsToQuiz: typeof addQuestionsToQuiz;
+    addSection: typeof addSection;
+    answerChoice: typeof answerChoice;
+    assignmentSubmissions: typeof assignmentSubmissions;
+    completionReport: typeof completionReport;
+    conversation: typeof conversation;
+    conversations: typeof conversations;
+    courseAbilities: typeof courseAbilities;
+    courseActivityTypes: typeof courseActivityTypes;
+    courseRoles: typeof courseRoles;
+    courseStructure: typeof courseStructure;
+    courseUpdates: typeof courseUpdates;
+    createActivity: typeof createActivity;
+    createEvent: typeof createEvent;
+    createQuestion: typeof createQuestion;
+    deadlines: typeof deadlines;
+    deleteActivity: typeof deleteActivity;
+    deleteEvent: typeof deleteEvent;
+    deleteSection: typeof deleteSection;
+    discussion: typeof discussion;
+    duplicateActivity: typeof duplicateActivity;
+    editActivity: typeof editActivity;
+    editSection: typeof editSection;
+    finishQuizAttempt: typeof finishQuizAttempt;
+    forumDiscussions: typeof forumDiscussions;
+    getChoice: typeof getChoice;
+    getSurvey: typeof getSurvey;
+    gradeSubmission: typeof gradeSubmission;
+    gradebookSetup: typeof gradebookSetup;
+    graderReport: typeof graderReport;
+    grantExtension: typeof grantExtension;
+    groups: typeof groups;
+    h5pActivity: typeof h5pActivity;
+    scorm: typeof scorm;
+    importQuestions: typeof importQuestions;
+    lessonPage: typeof lessonPage;
+    listAssignments: typeof listAssignments;
+    listCourses: typeof listCourses;
+    logOut: typeof logOut;
+    markNotificationsRead: typeof markNotificationsRead;
+    myGrades: typeof myGrades;
+    notifications: typeof notifications;
+    openForm: typeof openForm;
+    openSitePage: typeof openSitePage;
+    overrideCompletion: typeof overrideCompletion;
+    participantFilters: typeof participantFilters;
+    participants: typeof participants;
+    pendingActivities: typeof pendingActivities;
+    questionBanks: typeof questionBanks;
+    questions: typeof questions;
+    quizInfo: typeof quizInfo;
+    quizResults: typeof quizResults;
+    quizStructure: typeof quizStructure;
+    readAttempt: typeof readAttempt;
+    readReview: typeof readReview;
+    replyToPost: typeof replyToPost;
+    rubric: typeof rubric;
+    saveSubmission: typeof saveSubmission;
+    sendMessage: typeof sendMessage;
+    setCompletion: typeof setCompletion;
+    setDiscussionState: typeof setDiscussionState;
+    setQuizOverride: typeof setQuizOverride;
+    siteName: typeof siteName;
+    startDiscussion: typeof startDiscussion;
+    startQuizAttempt: typeof startQuizAttempt;
+    studentAssignment: typeof studentAssignment;
+    submitForGrading: typeof submitForGrading;
+    submitSurvey: typeof submitSurvey;
+    upcomingEvents: typeof upcomingEvents;
+    updateActivity: typeof updateActivity;
+    updateCourse: typeof updateCourse;
+    updateGradeItem: typeof updateGradeItem;
+    userById: typeof userById;
+    whoAmI: typeof whoAmI;
+};
+type SiteFunctions = typeof SITE_FUNCTIONS;
+/** A function of `(context, siteUrl, ...rest)` as a method of `(...rest)`. */
+type Bound<F> = F extends (context: BrowserContext, siteUrl: string, ...rest: infer A) => infer R ? (...rest: A) => R : never;
+/** The methods bound from the site functions, each named and documented as its function. */
+export type MoodleMethods = {
+    [K in keyof SiteFunctions]: Bound<SiteFunctions[K]>;
+};
+/** The names of the methods a `Moodle` has from the driver's functions, one per function of that name. */
+export declare const MOODLE_METHODS: readonly string[];
+/** What the object does when a call doesn't say: every one can still be given per call. */
+export interface MoodleDefaults {
+    /** How student actions read and answer: "realistic" (the default, at a reader's pace) or "fast" (ADR-005). */
+    trail?: Trail;
+    /** Called every few seconds while a student action waits at a reader's pace: the seconds elapsed, and the total when known. */
+    onProgress?: (elapsedSeconds: number, totalSeconds?: number) => void;
+    /** How long `logIn` waits for the person to log in, in milliseconds: five minutes unless given. */
+    loginTimeoutMs?: number;
+    /** Where `downloadFile` saves files when not given a folder (an absolute path). */
+    downloadDir?: string;
+}
+/** A student action's pace for one call, over the object's defaults. */
+type PaceOptions<P> = {
+    trail?: Trail;
+    onProgress?: P;
+};
+/**
+ * One Moodle site worked through one browser: the driver's operations as methods, without the
+ * browser context and the site the functions take first (`moodle.listCourses()` is
+ * `listCourses(context, site)`), plus the session and the browser. The pieces the operations are
+ * built from stay functions only.
+ */
+export interface Moodle extends MoodleMethods {
+    /** The site's base URL, normalized (a trailing slash). */
+    readonly site: string;
+    /** The browser manager underneath, for what the methods don't cover. */
+    readonly browser: BrowserManager;
+    /** The defaults the object was made with. */
+    readonly defaults: Readonly<MoodleDefaults>;
+    /** The browser's context, launching it if needed: what the functions take. */
+    context(): Promise<BrowserContext>;
+    /** Makes sure there's a session: at once if there is one, else a window where the person logs in (`loginTimeoutMs` by default). */
+    logIn(options?: {
+        timeoutMs?: number;
+        onWait?: (elapsedMs: number) => void;
+    }): Promise<LoginResult>;
+    /** What the site tells anyone before logging in, without the browser. */
+    publicSiteInfo(): ReturnType<typeof publicSiteInfo>;
+    /** Calls one of Moodle's AJAX services as the logged-in person. */
+    callService<T>(methodname: string, args: Record<string, unknown>): Promise<T>;
+    /** `activityContent`, at the object's `trail` unless given. */
+    activityContent(activity: {
+        id: number;
+        type: string;
+    }, options?: PaceOptions<(secondsRead: number) => void>): Promise<ActivityContent>;
+    activityContent(activityId: number, type: ContentType, options?: PaceOptions<(secondsRead: number) => void>): Promise<ActivityContent>;
+    /** `answerQuizQuestions`, at the object's `trail` unless given. */
+    answerQuizQuestions(attemptId: number, answers: Parameters<typeof answerQuizQuestions>[3], options?: PaceOptions<(elapsed: number, total: number) => void>): Promise<{
+        changed: string;
+        attemptId: number;
+        questions: Question[];
+    }>;
+    /** `answerLessonPage`, at the object's `trail` unless given. */
+    answerLessonPage(activityId: number, answer: Parameters<typeof answerLessonPage>[3], options?: PaceOptions<(elapsed: number, total: number) => void>): Promise<{
+        changed: string;
+        feedback?: LessonPage;
+        page: LessonPage;
+    }>;
+    /** `downloadFile`, into the object's `downloadDir` unless given a folder. */
+    downloadFile(url: string, destDir?: string): Promise<DownloadedFile>;
+    /** The working tab a program drives itself (ADR-007). */
+    tab(): Promise<Page>;
+    /** `openScorm`: a SCORM's player, on the working tab. */
+    openScorm(activityId: number, options?: {
+        scoId?: number;
+        newAttempt?: boolean;
+    }): Promise<OpenedScorm>;
+    /** Whether the browser shows a window now. */
+    visible(): boolean;
+    /** Shows the browser and follows the pages methods open, or hides it. */
+    setVisible(visible: boolean): Promise<void>;
+    /** Saves the session cookies of the open browser now. */
+    saveSession(): Promise<void>;
+    /** Saves the session and closes the browser; the next call opens it again. */
+    close(): Promise<void>;
+    /** `close()`, so `await using moodle = createMoodle(…)` closes the browser when the block ends. */
+    [Symbol.asyncDispose](): Promise<void>;
+}
+/** A site, the browser to work it with (its options for a new browser manager, or one already made), and the object's defaults. */
+export type MoodleOptions = MoodleDefaults & (({
+    site: string;
+} & BrowserOptions) | {
+    site: string;
+    browser: BrowserManager;
+});
+/**
+ * Works one Moodle site through a browser: give the site and the browser's options (or a browser
+ * manager), and optionally the defaults its calls use; then call the driver's operations as methods.
+ *
+ * ```ts
+ * const moodle = createMoodle({ site: "https://campus.example.org/", profileDir: "/home/me/.moodle-profile", headless: true, downloadBrowser: true, trail: "fast" });
+ * await moodle.logIn();
+ * const courses = await moodle.listCourses();
+ * await moodle.close();
+ * ```
+ */
+export declare function createMoodle(options: MoodleOptions): Moodle;
+export {};

package/dist/client.js

@@ -0,0 +1,182 @@
+import { createBrowserManager } from "./browser/manager.js";
+import { parseSiteUrl } from "./options.js";
+import { activitySettings, addSection, createActivity, deleteActivity, deleteSection, duplicateActivity, editActivity, editSection, updateActivity } from "./areas/activities/build.js";
+import { callService } from "./core/ajax.js";
+import { createEvent, deleteEvent, upcomingEvents } from "./areas/calendar/calendar.js";
+import { answerChoice, getChoice } from "./areas/surveys/choice.js";
+import { completionReport, overrideCompletion, setCompletion } from "./areas/completion/completion.js";
+import { activityContent } from "./areas/activities/content.js";
+import { listCourses, updateCourse } from "./areas/courses/list.js";
+import { downloadFile } from "./core/files.js";
+import { openForm } from "./core/forms.js";
+import { discussion, forumDiscussions, replyToPost, setDiscussionState, startDiscussion } from "./areas/forums/posts.js";
+import { addGradeCategory, gradebookSetup, graderReport, updateGradeItem } from "./areas/grades/gradebook.js";
+import { myGrades } from "./areas/grades/user-report.js";
+import { assignmentSubmissions, gradeSubmission, grantExtension, rubric } from "./areas/assignments/grading.js";
+import { h5pActivity } from "./areas/h5p/h5p.js";
+import { openScorm, scorm } from "./areas/scorm/scorm.js";
+import { answerLessonPage, lessonPage } from "./areas/lessons/lessons.js";
+import { logIn } from "./core/login.js";
+import { conversation, conversations, markNotificationsRead, notifications, sendMessage } from "./areas/messages/messages.js";
+import { activitiesOverview, courseUpdates, deadlines } from "./areas/courses/overview.js";
+import { groups, participantFilters, participants } from "./areas/participants/participants.js";
+import { createQuestion, importQuestions, questionBanks, questions } from "./areas/questions/banks.js";
+import { answerQuizQuestions, finishQuizAttempt, quizInfo, readAttempt, readReview, setQuizOverride, startQuizAttempt } from "./areas/quizzes/attempts.js";
+import { quizResults } from "./areas/quizzes/results.js";
+import { addQuestionsToQuiz, quizStructure } from "./areas/quizzes/structure.js";
+import { logOut, openSitePage } from "./core/session.js";
+import { courseActivityTypes, publicSiteInfo } from "./areas/site/info.js";
+import { courseStructure, listAssignments, pendingActivities } from "./areas/courses/structure.js";
+import { saveSubmission, studentAssignment, submitForGrading } from "./areas/assignments/student.js";
+import { getSurvey, submitSurvey } from "./areas/surveys/surveys.js";
+import { courseAbilities, courseRoles, siteName, userById, whoAmI } from "./areas/site/users.js";
+import { MoodleError } from "./core/errors.js";
+/**
+ * The functions that take the browser context and the site first, of the high-level API: each becomes
+ * a method of the same name without those two parameters. The pieces they're built from (an
+ * assignment's ids, its grading panel, a quiz attempt's steps…) stay functions only; the ones that
+ * use the object's defaults (`trail`, `downloadDir`…) and `callService`, generic, are bound by hand.
+ */
+const SITE_FUNCTIONS = {
+    activitiesOverview,
+    activitySettings,
+    addGradeCategory,
+    addQuestionsToQuiz,
+    addSection,
+    answerChoice,
+    assignmentSubmissions,
+    completionReport,
+    conversation,
+    conversations,
+    courseAbilities,
+    courseActivityTypes,
+    courseRoles,
+    courseStructure,
+    courseUpdates,
+    createActivity,
+    createEvent,
+    createQuestion,
+    deadlines,
+    deleteActivity,
+    deleteEvent,
+    deleteSection,
+    discussion,
+    duplicateActivity,
+    editActivity,
+    editSection,
+    finishQuizAttempt,
+    forumDiscussions,
+    getChoice,
+    getSurvey,
+    gradeSubmission,
+    gradebookSetup,
+    graderReport,
+    grantExtension,
+    groups,
+    h5pActivity,
+    scorm,
+    importQuestions,
+    lessonPage,
+    listAssignments,
+    listCourses,
+    logOut,
+    markNotificationsRead,
+    myGrades,
+    notifications,
+    openForm,
+    openSitePage,
+    overrideCompletion,
+    participantFilters,
+    participants,
+    pendingActivities,
+    questionBanks,
+    questions,
+    quizInfo,
+    quizResults,
+    quizStructure,
+    readAttempt,
+    readReview,
+    replyToPost,
+    rubric,
+    saveSubmission,
+    sendMessage,
+    setCompletion,
+    setDiscussionState,
+    setQuizOverride,
+    siteName,
+    startDiscussion,
+    startQuizAttempt,
+    studentAssignment,
+    submitForGrading,
+    submitSurvey,
+    upcomingEvents,
+    updateActivity,
+    updateCourse,
+    updateGradeItem,
+    userById,
+    whoAmI,
+};
+// Functions bound by hand, with the object's defaults: methods of the same name all the same.
+const DEFAULTED = ["activityContent", "answerQuizQuestions", "answerLessonPage", "downloadFile"];
+/** The names of the methods a `Moodle` has from the driver's functions, one per function of that name. */
+export const MOODLE_METHODS = [...Object.keys(SITE_FUNCTIONS), ...DEFAULTED];
+/**
+ * Works one Moodle site through a browser: give the site and the browser's options (or a browser
+ * manager), and optionally the defaults its calls use; then call the driver's operations as methods.
+ *
+ * ```ts
+ * const moodle = createMoodle({ site: "https://campus.example.org/", profileDir: "/home/me/.moodle-profile", headless: true, downloadBrowser: true, trail: "fast" });
+ * await moodle.logIn();
+ * const courses = await moodle.listCourses();
+ * await moodle.close();
+ * ```
+ */
+export function createMoodle(options) {
+    const site = parseSiteUrl(options.site);
+    const browser = "browser" in options ? options.browser : createBrowserManager(options);
+    const defaults = { trail: options.trail, onProgress: options.onProgress, loginTimeoutMs: options.loginTimeoutMs, downloadDir: options.downloadDir };
+    const bound = {};
+    for (const [name, fn] of Object.entries(SITE_FUNCTIONS)) {
+        const call = fn;
+        bound[name] = async (...args) => call(await browser.context(), site, ...args);
+    }
+    // Only what's set: an undefined option would hide the function's own default.
+    const pace = (given = {}, progress) => ({
+        ...(given.trail ?? defaults.trail ? { trail: given.trail ?? defaults.trail } : {}),
+        ...(given.onProgress ?? progress ? { onProgress: given.onProgress ?? progress } : {}),
+    });
+    const onProgress = defaults.onProgress;
+    return {
+        ...bound,
+        site,
+        browser,
+        defaults,
+        context: () => browser.context(),
+        logIn: (loginOptions = {}) => logIn(browser, site, { ...loginOptions, timeoutMs: loginOptions.timeoutMs ?? defaults.loginTimeoutMs }),
+        publicSiteInfo: () => publicSiteInfo(site),
+        callService: async (methodname, args) => callService(await browser.context(), site, methodname, args),
+        activityContent: async (activityOrId, typeOrOptions, given) => {
+            const context = await browser.context();
+            const progress = onProgress && ((read) => onProgress(read));
+            if (typeof activityOrId === "number")
+                return activityContent(context, site, activityOrId, typeOrOptions, pace(given, progress));
+            return activityContent(context, site, activityOrId, pace(typeOrOptions, progress));
+        },
+        answerQuizQuestions: async (attemptId, answers, given) => answerQuizQuestions(await browser.context(), site, attemptId, answers, pace(given, onProgress)),
+        answerLessonPage: async (activityId, answer, given) => answerLessonPage(await browser.context(), site, activityId, answer, pace(given, onProgress)),
+        downloadFile: async (url, destDir) => {
+            const folder = destDir ?? defaults.downloadDir;
+            if (!folder)
+                throw new MoodleError("Give downloadFile a folder, or createMoodle a downloadDir.", "invalid-input");
+            return downloadFile(await browser.context(), site, url, folder);
+        },
+        tab: () => browser.tab(),
+        openScorm: (activityId, scormOptions) => openScorm(browser, site, activityId, scormOptions),
+        visible: () => browser.visible(),
+        setVisible: (visible) => browser.setVisible(visible),
+        saveSession: () => browser.saveSession(),
+        close: () => browser.close(),
+        [Symbol.asyncDispose]: () => browser.close(),
+    };
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAuB,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,YAAY,EAAmC,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AACxL,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACvG,OAAO,EAAE,eAAe,EAA0C,MAAM,+BAA+B,CAAC;AACxG,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAuB,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AACzH,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9G,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAChH,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,KAAK,EAAoB,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAmB,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,KAAK,EAAoB,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC9H,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAC3F,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAChG,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvG,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,gBAAgB,EAAiB,MAAM,6BAA6B,CAAC;AAC1K,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AACjF,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACrG,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACjG,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,cAAc,GAAG;IACrB,kBAAkB;IAClB,gBAAgB;IAChB,gBAAgB;IAChB,kBAAkB;IAClB,UAAU;IACV,YAAY;IACZ,qBAAqB;IACrB,gBAAgB;IAChB,YAAY;IACZ,aAAa;IACb,eAAe;IACf,mBAAmB;IACnB,WAAW;IACX,eAAe;IACf,aAAa;IACb,cAAc;IACd,WAAW;IACX,cAAc;IACd,SAAS;IACT,cAAc;IACd,WAAW;IACX,aAAa;IACb,UAAU;IACV,iBAAiB;IACjB,YAAY;IACZ,WAAW;IACX,iBAAiB;IACjB,gBAAgB;IAChB,SAAS;IACT,SAAS;IACT,eAAe;IACf,cAAc;IACd,YAAY;IACZ,cAAc;IACd,MAAM;IACN,WAAW;IACX,KAAK;IACL,eAAe;IACf,UAAU;IACV,eAAe;IACf,WAAW;IACX,MAAM;IACN,qBAAqB;IACrB,QAAQ;IACR,aAAa;IACb,QAAQ;IACR,YAAY;IACZ,kBAAkB;IAClB,kBAAkB;IAClB,YAAY;IACZ,iBAAiB;IACjB,aAAa;IACb,SAAS;IACT,QAAQ;IACR,WAAW;IACX,aAAa;IACb,WAAW;IACX,UAAU;IACV,WAAW;IACX,MAAM;IACN,cAAc;IACd,WAAW;IACX,aAAa;IACb,kBAAkB;IAClB,eAAe;IACf,QAAQ;IACR,eAAe;IACf,gBAAgB;IAChB,iBAAiB;IACjB,gBAAgB;IAChB,YAAY;IACZ,cAAc;IACd,cAAc;IACd,YAAY;IACZ,eAAe;IACf,QAAQ;IACR,MAAM;CACP,CAAC;AAUF,8FAA8F;AAC9F,MAAM,SAAS,GAAG,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,cAAc,CAAU,CAAC;AAE1G,0GAA0G;AAC1G,MAAM,CAAC,MAAM,cAAc,GAAsB,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC;AAmEhG;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,SAAS,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACvF,MAAM,QAAQ,GAAmB,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;IACpK,MAAM,KAAK,GAA6D,EAAE,CAAC;IAC3E,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,GAAG,EAAwF,CAAC;QACtG,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,EAAE,GAAG,IAAe,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IAC3F,CAAC;IACD,8EAA8E;IAC9E,MAAM,IAAI,GAAG,CAAI,QAAwB,EAAE,EAAE,QAAY,EAAE,EAAE,CAAC,CAAC;QAC7D,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClF,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtF,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;IACvC,OAAO;QACL,GAAI,KAAkC;QACtC,IAAI;QACJ,OAAO;QACP,QAAQ;QACR,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE;QAChC,KAAK,EAAE,CAAC,YAAY,GAAG,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,YAAY,EAAE,SAAS,EAAE,YAAY,CAAC,SAAS,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;QACrI,cAAc,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC;QAC1C,WAAW,EAAE,KAAK,EAAK,UAAkB,EAAE,IAA6B,EAAE,EAAE,CAAC,WAAW,CAAI,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC;QAC5I,eAAe,EAAE,KAAK,EACpB,YAAmD,EACnD,aAAwE,EACxE,KAAkD,EAClD,EAAE;YACF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YACxC,MAAM,QAAQ,GAAG,UAAU,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;YACpE,IAAI,OAAO,YAAY,KAAK,QAAQ;gBAAE,OAAO,eAAe,CAAC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,aAA4B,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC/I,OAAO,eAAe,CAAC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,aAAuE,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC/I,CAAC;QACD,mBAAmB,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACzJ,gBAAgB,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACnJ,YAAY,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;YACnC,MAAM,MAAM,GAAG,OAAO,IAAI,QAAQ,CAAC,WAAW,CAAC;YAC/C,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,WAAW,CAAC,4DAA4D,EAAE,eAAe,CAAC,CAAC;YAClH,OAAO,YAAY,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QAClE,CAAC;QACD,GAAG,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;QACxB,SAAS,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,CAAC;QAC3F,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE;QAChC,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;QACpD,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE;QACxC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE;QAC5B,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE;KAC7C,CAAC;AACJ,CAAC"}

package/dist/core/ajax.d.ts

@@ -0,0 +1,25 @@
+import type { BrowserContext } from "playwright-core";
+import { MoodleError } from "./errors.js";
+/** A Moodle AJAX service answered with an exception. */
+export declare class MoodleServiceError extends MoodleError {
+    readonly methodname: string;
+    readonly errorcode: string;
+    name: string;
+    constructor(methodname: string, errorcode: string, message: string);
+}
+/** What `M.cfg` says about the logged-in person. */
+export interface PageConfig {
+    userId: number;
+    language: string;
+    timeZone: string;
+}
+/** The response of `lib/ajax/service.php` for one request: `data`, or throws. */
+export declare function parseServiceResponse<T>(methodname: string, status: number, body: string): T;
+/**
+ * Calls one of Moodle's AJAX services as the logged-in person: a request to `lib/ajax/service.php`
+ * with the profile's session and its sesskey, as Moodle's pages make them, without a tab (ADR-004,
+ * ADR-011). Throws `NotLoggedInError` when there's no session, `MoodleServiceError` when the service fails.
+ */
+export declare function callService<T>(context: BrowserContext, siteUrl: string, methodname: string, args: Record<string, unknown>): Promise<T>;
+/** The logged-in person's id, interface language and time zone, from `M.cfg`, read now: someone else may have logged in since. */
+export declare function readPageConfig(context: BrowserContext, siteUrl: string): Promise<PageConfig>;

package/dist/core/ajax.js

@@ -0,0 +1,85 @@
+import { NotLoggedInError, fetchSitePage, readMoodleConfig } from "./session.js";
+import { MoodleError } from "./errors.js";
+import { siteFetch } from "./http.js";
+/** A Moodle AJAX service answered with an exception. */
+export class MoodleServiceError extends MoodleError {
+    methodname;
+    errorcode;
+    name = "MoodleServiceError";
+    constructor(methodname, errorcode, message) {
+        super(`Moodle's ${methodname} failed (${errorcode}): ${message}`, "moodle-service");
+        this.methodname = methodname;
+        this.errorcode = errorcode;
+    }
+}
+// What service.php answers when the session is gone or the sesskey is from an older one.
+const SESSION_ERRORS = new Set(["servicerequireslogin", "invalidsesskey"]);
+// A light page that needs a session: its `M.cfg` carries the session's sesskey and the person's settings.
+const SESSION_PAGE = "user/preferences.php";
+// Per context: the site, the session's sesskey and the person's settings, read once from a page (ADR-011).
+const sessions = new WeakMap();
+async function session(context, siteUrl, fresh) {
+    const current = sessions.get(context);
+    // The program may have changed the site since the sesskey was read.
+    if (current && current.siteUrl === siteUrl && !fresh)
+        return current;
+    const { html } = await fetchSitePage(context, siteUrl, SESSION_PAGE, { follow: false });
+    const cfg = readMoodleConfig(html) ?? {};
+    if (typeof cfg.sesskey !== "string")
+        throw new NotLoggedInError();
+    const config = { userId: Number(cfg.userId), language: String(cfg.language), timeZone: String(cfg.usertimezone) };
+    const next = { siteUrl, sesskey: cfg.sesskey, config };
+    sessions.set(context, next);
+    return next;
+}
+/** The response of `lib/ajax/service.php` for one request: `data`, or throws. */
+export function parseServiceResponse(methodname, status, body) {
+    let responses;
+    try {
+        responses = JSON.parse(body);
+    }
+    catch {
+        throw new MoodleServiceError(methodname, `http${status}`, "the answer isn't JSON");
+    }
+    const response = (Array.isArray(responses) ? responses[0] : responses);
+    if (!response)
+        throw new MoodleServiceError(methodname, `http${status}`, "empty answer");
+    if (response.error === false)
+        return response.data;
+    // A failure before any function runs (bad sesskey) comes as a bare exception object.
+    const exception = response.exception ?? response;
+    throw new MoodleServiceError(methodname, exception.errorcode ?? "unknown", exception.message ?? "no message");
+}
+/**
+ * Calls one of Moodle's AJAX services as the logged-in person: a request to `lib/ajax/service.php`
+ * with the profile's session and its sesskey, as Moodle's pages make them, without a tab (ADR-004,
+ * ADR-011). Throws `NotLoggedInError` when there's no session, `MoodleServiceError` when the service fails.
+ */
+export async function callService(context, siteUrl, methodname, args) {
+    for (const fresh of [false, true]) {
+        const { sesskey } = await session(context, siteUrl, fresh);
+        const url = new URL(`lib/ajax/service.php?sesskey=${encodeURIComponent(sesskey)}&info=${encodeURIComponent(methodname)}`, siteUrl).href;
+        const { status, body } = await siteFetch(context, url, {
+            method: "POST",
+            headers: { "Content-Type": "application/json" },
+            body: JSON.stringify([{ index: 0, methodname, args }]),
+        });
+        try {
+            return parseServiceResponse(methodname, status, body);
+        }
+        catch (error) {
+            const sessionError = error instanceof MoodleServiceError && SESSION_ERRORS.has(error.errorcode);
+            if (!sessionError)
+                throw error;
+            // The sesskey may be stale (a new login, an expiry): reading it again tells which.
+            if (fresh)
+                throw new NotLoggedInError();
+        }
+    }
+    throw new NotLoggedInError(); // Unreachable: the fresh attempt returns or throws.
+}
+/** The logged-in person's id, interface language and time zone, from `M.cfg`, read now: someone else may have logged in since. */
+export async function readPageConfig(context, siteUrl) {
+    return (await session(context, siteUrl, true)).config;
+}
+//# sourceMappingURL=ajax.js.map

package/dist/core/ajax.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ajax.js","sourceRoot":"","sources":["../../src/core/ajax.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACjF,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,wDAAwD;AACxD,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IAGtC;IACA;IAHF,IAAI,GAAG,oBAAoB,CAAC;IACrC,YACW,UAAkB,EAClB,SAAiB,EAC1B,OAAe;QAEf,KAAK,CAAC,YAAY,UAAU,YAAY,SAAS,MAAM,OAAO,EAAE,EAAE,gBAAgB,CAAC,CAAC;QAJ3E,eAAU,GAAV,UAAU,CAAQ;QAClB,cAAS,GAAT,SAAS,CAAQ;IAI5B,CAAC;CACF;AAED,yFAAyF;AACzF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,sBAAsB,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAE3E,0GAA0G;AAC1G,MAAM,YAAY,GAAG,sBAAsB,CAAC;AAS5C,2GAA2G;AAC3G,MAAM,QAAQ,GAAG,IAAI,OAAO,EAA4E,CAAC;AAEzG,KAAK,UAAU,OAAO,CAAC,OAAuB,EAAE,OAAe,EAAE,KAAc;IAC7E,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtC,oEAAoE;IACpE,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,KAAK,OAAO,IAAI,CAAC,KAAK;QAAE,OAAO,OAAO,CAAC;IACrE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACxF,MAAM,GAAG,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACzC,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ;QAAE,MAAM,IAAI,gBAAgB,EAAE,CAAC;IAClE,MAAM,MAAM,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;IAClH,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IACvD,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5B,OAAO,IAAI,CAAC;AACd,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,oBAAoB,CAAI,UAAkB,EAAE,MAAc,EAAE,IAAY;IACtF,IAAI,SAAkB,CAAC;IACvB,IAAI,CAAC;QACH,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,kBAAkB,CAAC,UAAU,EAAE,OAAO,MAAM,EAAE,EAAE,uBAAuB,CAAC,CAAC;IACrF,CAAC;IACD,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAExD,CAAC;IACd,IAAI,CAAC,QAAQ;QAAE,MAAM,IAAI,kBAAkB,CAAC,UAAU,EAAE,OAAO,MAAM,EAAE,EAAE,cAAc,CAAC,CAAC;IACzF,IAAI,QAAQ,CAAC,KAAK,KAAK,KAAK;QAAE,OAAO,QAAQ,CAAC,IAAS,CAAC;IACxD,qFAAqF;IACrF,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,IAAI,QAAQ,CAAC;IACjD,MAAM,IAAI,kBAAkB,CAAC,UAAU,EAAE,SAAS,CAAC,SAAS,IAAI,SAAS,EAAE,SAAS,CAAC,OAAO,IAAI,YAAY,CAAC,CAAC;AAChH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAI,OAAuB,EAAE,OAAe,EAAE,UAAkB,EAAE,IAA6B;IAC9H,KAAK,MAAM,KAAK,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;QAClC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC3D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,gCAAgC,kBAAkB,CAAC,OAAO,CAAC,SAAS,kBAAkB,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;QACxI,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE;YACrD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;SACvD,CAAC,CAAC;QACH,IAAI,CAAC;YACH,OAAO,oBAAoB,CAAI,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAAG,KAAK,YAAY,kBAAkB,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAChG,IAAI,CAAC,YAAY;gBAAE,MAAM,KAAK,CAAC;YAC/B,mFAAmF;YACnF,IAAI,KAAK;gBAAE,MAAM,IAAI,gBAAgB,EAAE,CAAC;QAC1C,CAAC;IACH,CAAC;IACD,MAAM,IAAI,gBAAgB,EAAE,CAAC,CAAC,oDAAoD;AACpF,CAAC;AAED,kIAAkI;AAClI,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAuB,EAAE,OAAe;IAC3E,OAAO,CAAC,MAAM,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;AACxD,CAAC"}

package/dist/core/editor.d.ts

@@ -0,0 +1,18 @@
+import type { BrowserContext } from "playwright-core";
+/** The course editor's actions this server uses (`core_courseformat\stateactions`, Moodle 4.0–5.2). */
+export type EditorAction = "cm_show" | "cm_hide" | "cm_stealth" | "cm_move" | "cm_duplicate" | "cm_delete" | "section_add" | "section_show" | "section_hide" | "section_move_after" | "section_delete";
+/**
+ * Runs one of the course editor's actions through its own service (ADR-004), as the editor does:
+ * ids of activities or sections, and a target section (`cm_move`: at its end; `section_add`,
+ * `section_move_after`: after it) or a target activity (`cm_move`: before it).
+ */
+export declare function editCourse(context: BrowserContext, siteUrl: string, courseId: number, action: EditorAction, ids: number[], target?: {
+    sectionId?: number;
+    activityId?: number;
+}): Promise<void>;
+/** The course format (topics, weeks…), a class of the course page's body: no service tells teachers. */
+export declare function courseFormat(context: BrowserContext, siteUrl: string, courseId: number): Promise<string>;
+/** Renames an activity, as the course page's in-place editor does. */
+export declare function renameActivity(context: BrowserContext, siteUrl: string, activityId: number, name: string): Promise<void>;
+/** Renames a section through its course format's in-place editor. */
+export declare function renameSection(context: BrowserContext, siteUrl: string, courseId: number, sectionId: number, name: string): Promise<void>;

package/dist/core/editor.js

@@ -0,0 +1,51 @@
+import { callService } from "./ajax.js";
+import { openSitePage } from "./session.js";
+import { MoodleError } from "./errors.js";
+/**
+ * Runs one of the course editor's actions through its own service (ADR-004), as the editor does:
+ * ids of activities or sections, and a target section (`cm_move`: at its end; `section_add`,
+ * `section_move_after`: after it) or a target activity (`cm_move`: before it).
+ */
+export async function editCourse(context, siteUrl, courseId, action, ids, target = {}) {
+    await callService(context, siteUrl, "core_courseformat_update_course", {
+        action,
+        courseid: courseId,
+        ids,
+        ...(target.sectionId ? { targetsectionid: target.sectionId } : {}),
+        ...(target.activityId ? { targetcmid: target.activityId } : {}),
+    });
+}
+// A course's format doesn't change while a program runs.
+const formats = new Map();
+/** The course format (topics, weeks…), a class of the course page's body: no service tells teachers. */
+export async function courseFormat(context, siteUrl, courseId) {
+    const key = `${siteUrl}|${courseId}`;
+    const cached = formats.get(key);
+    if (cached)
+        return cached;
+    const page = await openSitePage(context, siteUrl, `course/view.php?id=${courseId}`);
+    try {
+        const classes = await page.evaluate(() => globalThis.document.body.className);
+        const format = classes
+            .split(" ")
+            .find((name) => name.startsWith("format-"))
+            ?.slice("format-".length);
+        if (!format)
+            throw new MoodleError(`Course ${courseId}'s format isn't on its page.`, "unexpected-page");
+        formats.set(key, format);
+        return format;
+    }
+    finally {
+        await page.close().catch(() => undefined);
+    }
+}
+/** Renames an activity, as the course page's in-place editor does. */
+export async function renameActivity(context, siteUrl, activityId, name) {
+    await callService(context, siteUrl, "core_update_inplace_editable", { component: "core_course", itemtype: "activityname", itemid: activityId, value: name });
+}
+/** Renames a section through its course format's in-place editor. */
+export async function renameSection(context, siteUrl, courseId, sectionId, name) {
+    const format = await courseFormat(context, siteUrl, courseId);
+    await callService(context, siteUrl, "core_update_inplace_editable", { component: `format_${format}`, itemtype: "sectionname", itemid: sectionId, value: name });
+}
+//# sourceMappingURL=editor.js.map

package/dist/core/editor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.js","sourceRoot":"","sources":["../../src/core/editor.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAgB1C;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,OAAuB,EACvB,OAAe,EACf,QAAgB,EAChB,MAAoB,EACpB,GAAa,EACb,SAAsD,EAAE;IAExD,MAAM,WAAW,CAAS,OAAO,EAAE,OAAO,EAAE,iCAAiC,EAAE;QAC7E,MAAM;QACN,QAAQ,EAAE,QAAQ;QAClB,GAAG;QACH,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAChE,CAAC,CAAC;AACL,CAAC;AAED,yDAAyD;AACzD,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;AAE1C,wGAAwG;AACxG,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB;IAC3F,MAAM,GAAG,GAAG,GAAG,OAAO,IAAI,QAAQ,EAAE,CAAC;IACrC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAC1B,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,sBAAsB,QAAQ,EAAE,CAAC,CAAC;IACpF,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAE,UAAuE,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5I,MAAM,MAAM,GAAG,OAAO;aACnB,KAAK,CAAC,GAAG,CAAC;aACV,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAC3C,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC5B,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,WAAW,CAAC,UAAU,QAAQ,8BAA8B,EAAE,iBAAiB,CAAC,CAAC;QACxG,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;YAAS,CAAC;QACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC;AAED,sEAAsE;AACtE,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAuB,EAAE,OAAe,EAAE,UAAkB,EAAE,IAAY;IAC7G,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,8BAA8B,EAAE,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAC/J,CAAC;AAED,qEAAqE;AACrE,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAuB,EAAE,OAAe,EAAE,QAAgB,EAAE,SAAiB,EAAE,IAAY;IAC7H,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC9D,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,8BAA8B,EAAE,EAAE,SAAS,EAAE,UAAU,MAAM,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAClK,CAAC"}

package/dist/core/errors.d.ts

@@ -0,0 +1,12 @@
+/**
+ * What went wrong, stable across releases: match errors by `code` (or by class), never by message,
+ * whose wording may change. Each error class has its own code; `MoodleError` itself takes one
+ * of the generic ones.
+ */
+export type MoodleErrorCode = "invalid-input" | "not-found" | "not-available" | "outside-site" | "unexpected-page" | "logout-failed" | "chromium-install-failed" | "moodle-url" | "browser-not-found" | "browser-downloading" | "no-display" | "not-logged-in" | "login-timeout" | "login-window-closed" | "moodle-service" | "form" | "activity-settings" | "not-viewable" | "not-an-assignment" | "grading" | "submission" | "calendar" | "completion" | "course" | "not-a-forum" | "gradebook" | "no-grade-report" | "not-an-h5p-activity" | "scorm" | "lesson" | "message" | "no-participants" | "question-bank" | "quiz" | "choice" | "survey";
+/** Every error the driver throws on purpose: one class to catch, a stable `code` to tell them apart. */
+export declare class MoodleError extends Error {
+    name: string;
+    readonly code: MoodleErrorCode;
+    constructor(message: string, code: MoodleErrorCode);
+}