@mo7yw4ng/openape 1.0.1 → 1.0.3

package/esm/src/lib/moodle.d.ts

@@ -0,0 +1,251 @@
+import type { Page } from "playwright-core";
+import type { SessionInfo, Logger, EnrolledCourse, SuperVideoModule, QuizModule, ResourceModule, ForumDiscussion, ForumPost, CalendarEvent, CourseGrade } from "./types.js";
+/**
+ * Direct HTTP API call without browser (for WS API only).
+ * This is much faster than browser-based calls.
+ */
+export declare function moodleApiCall<T = unknown>(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, methodname: string, args: Record<string, unknown>): Promise<T>;
+/**
+ * Send a Moodle AJAX request and return the result.
+ * Uses Web Service token if available AND the function is in WS_API_FUNCTIONS,
+ * otherwise falls back to sesskey-based AJAX (via /lib/ajax/service.php).
+ */
+export declare function moodleAjax<T = unknown>(page: Page, session: SessionInfo, methodname: string, args: Record<string, unknown>): Promise<T>;
+/**
+ * Fetch enrolled courses via pure API (no browser required).
+ * Fast and lightweight - uses HTTP fetch directly.
+ */
+export declare function getEnrolledCoursesApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, options?: {
+    classification?: "inprogress" | "past" | "future" | "all";
+    limit?: number;
+}): Promise<EnrolledCourse[]>;
+/**
+ * Fetch all enrolled courses via Moodle AJAX API.
+ */
+export declare function getEnrolledCourses(page: Page, session: SessionInfo, log: Logger, options?: {
+    classification?: "inprogress" | "past" | "future";
+    limit?: number;
+}): Promise<EnrolledCourse[]>;
+/**
+ * Get course state (modules) via core_courseformat_get_state.
+ */
+export declare function getCourseState(page: Page, session: SessionInfo, courseId: number): Promise<any>;
+/**
+ * Get all SuperVideo modules in a course.
+ */
+export declare function getSupervideosInCourse(page: Page, session: SessionInfo, courseId: number, log: Logger, options?: {
+    incompleteOnly?: boolean;
+}): Promise<SuperVideoModule[]>;
+/**
+ * Get all forums via pure WS API (no browser required).
+ * Fast and lightweight - uses HTTP fetch directly.
+ */
+export declare function getForumsApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, courseIds: number[]): Promise<Array<{
+    id: number;
+    cmid: number;
+    name: string;
+    courseid: number;
+    timemodified: number;
+}>>;
+/**
+ * Get discussions in a forum via WS API (no browser required).
+ * Uses mod_forum_get_forum_discussions
+ */
+export declare function getForumDiscussionsApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, forumId: number, options?: {
+    sortorder?: number;
+    page?: number;
+    perpage?: number;
+    groupid?: number;
+}): Promise<ForumDiscussion[]>;
+/**
+ * Get posts in a discussion via WS API (no browser required).
+ * Uses mod_forum_get_forum_discussion_posts
+ */
+export declare function getDiscussionPostsApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, discussionId: number): Promise<ForumPost[]>;
+/**
+ * Get all resource modules in a course.
+ */
+export declare function getResourcesInCourse(page: Page, session: SessionInfo, courseId: number, log: Logger): Promise<ResourceModule[]>;
+/**
+ * Get calendar events via pure WS API (no browser required).
+ * Fast and lightweight - uses HTTP fetch directly.
+ */
+export declare function getCalendarEventsApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, options?: {
+    courseId?: number;
+    startTime?: number;
+    endTime?: number;
+    events?: {
+        courseid?: number;
+        groupid?: number;
+        categoryid?: number;
+    }[];
+}): Promise<CalendarEvent[]>;
+/**
+ * Get course grades for the current user via pure WS API (no browser required).
+ * Fast and lightweight - uses HTTP fetch directly.
+ */
+export declare function getCourseGradesApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, courseId: number): Promise<CourseGrade>;
+/**
+ * Visit a SuperVideo activity page and extract view_id + duration.
+ */
+/**
+ * Optimized video metadata extraction - minimal page load overhead.
+ * Blocks images, fonts, stylesheets to speed up viewId extraction.
+ */
+export declare function getVideoMetadata(page: Page, activityUrl: string, log: Logger): Promise<{
+    name: string;
+    url: string;
+    viewId: number;
+    duration: number;
+    existingPercent: number;
+    videoSources: string[];
+    youtubeIds?: string[];
+}>;
+/**
+ * Download a video from SuperVideo activity.
+ * Supports direct video URLs (pluginfile.php) and YouTube videos.
+ */
+export declare function downloadVideo(page: Page, metadata: {
+    name: string;
+    videoSources: string[];
+    youtubeIds?: string[];
+}, outputPath: string, log: Logger): Promise<{
+    success: boolean;
+    path?: string;
+    error?: string;
+    type?: string;
+}>;
+/**
+ * Complete a video using WS API (mobile service only).
+ * Uses mod_supervideo_progress_save_mobile which is accessible via moodle_mobile_app service token.
+ */
+export declare function completeVideoApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, video: {
+    viewId: number;
+    duration: number;
+    url: string;
+    cmid?: string;
+}): Promise<{
+    success: boolean;
+    error?: string;
+    result?: any;
+}>;
+/**
+ * Complete a video by forging progress AJAX call (legacy, requires browser).
+ * Note: This uses sesskey-based AJAX which works for mod_supervideo_progress_save.
+ */
+export declare function completeVideo(page: Page, session: SessionInfo, video: {
+    viewId: number;
+    duration: number;
+    url: string;
+    cmid?: string;
+}, log: Logger): Promise<boolean>;
+/**
+ * Update activity completion status manually via WS API.
+ * Used for marking resources as complete/incomplete.
+ */
+export declare function updateActivityCompletionStatusManually(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, cmid: number, completed: boolean): Promise<boolean>;
+/**
+ * Get site info including current user ID via pure WS API.
+ * Results are cached for 5 minutes to avoid redundant calls.
+ */
+export declare function getSiteInfoApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}): Promise<{
+    userid: number;
+    username: string;
+    fullname: string;
+    sitename: string;
+}>;
+/**
+ * Get incomplete supervideos with completion tracking enabled via WS API.
+ * Uses core_completion_get_activities_completion_status to get only videos that:
+ * 1. Have completion tracking enabled (hascompletion: true)
+ * 2. Are not yet completed (isoverallcomplete: false or state !== 1)
+ */
+export declare function getIncompleteVideosApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, courseId: number): Promise<Array<{
+    cmid: number;
+    name: string;
+    url: string;
+}>>;
+/**
+ * Get course contents and filter for SuperVideo modules via pure WS API.
+ */
+export declare function getSupervideosInCourseApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, courseId: number): Promise<SuperVideoModule[]>;
+/**
+ * Extended QuizModule with courseId for API responses.
+ */
+export interface QuizModuleWithCourse extends QuizModule {
+    courseId: number;
+}
+/**
+ * Get quizzes in courses via pure WS API.
+ */
+export declare function getQuizzesByCoursesApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, courseIds: number[]): Promise<QuizModuleWithCourse[]>;
+/**
+ * Get resources in courses via pure WS API.
+ */
+export declare function getResourcesByCoursesApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, courseIds: number[]): Promise<ResourceModule[]>;
+export interface Message {
+    id: number;
+    useridfrom: number;
+    useridto: number;
+    subject: string;
+    text: string;
+    timecreated: number;
+    fullmessage: string;
+    fullmessageformat: number;
+    fullmessagehtml: string;
+}
+/**
+ * Get messages for the current user via pure WS API.
+ */
+export declare function getMessagesApi(session: {
+    wsToken: string;
+    moodleBaseUrl: string;
+}, userIdTo: number, options?: {
+    useridfrom?: number;
+    read?: boolean;
+    limitfrom?: number;
+    limitnum?: number;
+}): Promise<Message[]>;
+//# sourceMappingURL=moodle.d.ts.map

package/esm/src/lib/moodle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"moodle.d.ts","sourceRoot":"","sources":["../../../src/src/lib/moodle.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,KAAK,EACV,WAAW,EACX,MAAM,EACN,cAAc,EACd,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,eAAe,EACf,SAAS,EACT,aAAa,EACb,WAAW,EACZ,MAAM,YAAY,CAAC;AAgDpB;;;GAGG;AACH,wBAAsB,aAAa,CAAC,CAAC,GAAG,OAAO,EAC7C,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,CAAC,CAAC,CAsBZ;AAED;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,CAAC,GAAG,OAAO,EAC1C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,WAAW,EACpB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,CAAC,CAAC,CAsDZ;AAID;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,OAAO,GAAE;IAAE,cAAc,CAAC,EAAE,YAAY,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAO,GAC1F,OAAO,CAAC,cAAc,EAAE,CAAC,CAkC3B;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,WAAW,EACpB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;IAAE,cAAc,CAAC,EAAE,YAAY,GAAG,MAAM,GAAG,QAAQ,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAO,GAClF,OAAO,CAAC,cAAc,EAAE,CAAC,CAuC3B;AAED;;GAEG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,GAAG,CAAC,CAWd;AAID;;GAEG;AACH,wBAAsB,sBAAsB,CAC1C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;IAAE,cAAc,CAAC,EAAE,OAAO,CAAA;CAAO,GACzC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA8B7B;AAID;;;GAGG;AACH,wBAAsB,YAAY,CAChC,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,KAAK,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC,CAcpG;AAED;;;GAGG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;IACR,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACA,OAAO,CAAC,eAAe,EAAE,CAAC,CAkC5B;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,SAAS,EAAE,CAAC,CA8BtB;AAID;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,cAAc,EAAE,CAAC,CAoB3B;AAID;;;GAGG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,OAAO,GAAE;IACP,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACpE,GACL,OAAO,CAAC,aAAa,EAAE,CAAC,CA4B1B;AAID;;;GAGG;AACH,wBAAsB,kBAAkB,CACtC,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,WAAW,CAAC,CA0BtB;AAID;;GAEG;AACH;;;GAGG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,MAAM,EACnB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,EAAE,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAkIlJ;AAID;;;GAGG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,EAAE,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,EACzE,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAwE7E;AAiBD;;;GAGG;AACH,wBAAsB,gBAAgB,CACpC,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,KAAK,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACtE,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC,CA0B7D;AAED;;;GAGG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,EACvE,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,OAAO,CAAC,CAqClB;AAED;;;GAGG;AACH,wBAAsB,sCAAsC,CAC1D,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,OAAO,GACjB,OAAO,CAAC,OAAO,CAAC,CAelB;AASD;;;GAGG;AACH,wBAAsB,cAAc,CAClC,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,GAClD,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAqBnF;AAED;;;;;GAKG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC,CAsD7D;AAID;;GAEG;AACH,wBAAsB,yBAAyB,CAC7C,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA+D7B;AAID;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAkBjC;AAID;;GAEG;AACH,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,cAAc,EAAE,CAAC,CAuB3B;AAID,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,wBAAsB,cAAc,CAClC,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,EACnD,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAO,GAC3F,OAAO,CAAC,OAAO,EAAE,CAAC,CAkBpB"}