@anantagnanam/lms 0.0.0-stage → 0.1.0

package/dist/runtime.d.ts

@@ -0,0 +1,681 @@
+import { AccessGrant, Acquisition, Actor, AuditRecord, Certificate, CertificateIndex, Cohort, CohortMembership, Course, CourseCard, CourseData, CourseDetail, CurriculumModule, Discussion, Enrollment, Lesson, LessonProgress, LmsOptions, LmsSettings, Notification, Page, ProgressSummary, PublicEnrollment, PublicLesson, PublicQuizAttempt, Review } from "./types.js";
+import * as emdash from "emdash";
+import { PluginContext, StorageCollection } from "emdash";
+import { z } from "zod";
+
+//#region src/store.d.ts
+interface LmsCollections {
+  courses: StorageCollection<Course>;
+  enrollments: StorageCollection<Enrollment>;
+  certificates: StorageCollection<CertificateIndex>;
+  discussions: StorageCollection<Discussion>;
+  reviews: StorageCollection<Review>;
+  cohorts: StorageCollection<Cohort>;
+  cohort_enrollments: StorageCollection<CohortMembership>;
+  notifications: StorageCollection<Notification>;
+  audit: StorageCollection<AuditRecord>;
+}
+//#endregion
+//#region src/curriculum.d.ts
+declare function findLesson(course: Course, lessonId: string): Lesson;
+//#endregion
+//#region src/service.d.ts
+declare class LmsService {
+  readonly ctx: PluginContext;
+  readonly now: () => Date;
+  readonly stores: LmsCollections;
+  constructor(ctx: PluginContext, now?: () => Date);
+  time(): string;
+  settings(): Promise<LmsSettings>;
+  saveSettings(actor: Actor | undefined, input: unknown): Promise<LmsSettings>;
+  audit(actor: Actor, action: string, resourceId: string, details?: Record<string, unknown>): Promise<void>;
+  course(id: string): Promise<Course>;
+  accessEnrollment(enrollment: Enrollment | null): Promise<Enrollment | null>;
+  enrollmentView(enrollment: Enrollment): Promise<PublicEnrollment>;
+  lessonAccess(course: Course, lessonId: string, enrollment: Enrollment | null): Promise<{
+    id: string;
+    title: string;
+    summary: string;
+    kind: "text" | "video" | "audio" | "quiz" | "assignment" | "live";
+    body: string;
+    portableText: Record<string, unknown>[];
+    contentSource: {
+      collection: string;
+      id: string;
+      field: string;
+    } | null;
+    mediaUrl: string | null;
+    liveStartsAt: string | null;
+    durationMinutes: number;
+    minStudySeconds: number;
+    preview: boolean;
+    required: boolean;
+    resources: {
+      id: string;
+      title: string;
+      url: string;
+      description: string;
+    }[];
+    quiz: {
+      questions: {
+        id: string;
+        type: "single" | "multiple" | "true_false" | "short";
+        prompt: string;
+        options: {
+          id: string;
+          text: string;
+        }[];
+        correctAnswers: string[];
+        points: number;
+        explanation: string;
+      }[];
+      passingPercent: number;
+      maxAttempts: number;
+      timeLimitMinutes: number;
+      randomizeQuestions: boolean;
+      randomizeOptions: boolean;
+      showFeedback: "never" | "after_pass" | "after_submit";
+    } | null;
+    assignment: {
+      instructions: string;
+      maxPoints: number;
+      passingPoints: number;
+      dueAt: string | null;
+      allowResubmission: boolean;
+    } | null;
+  }>;
+  instructor(course: Course, actor: Actor | undefined): Actor;
+  saveCourse(actor: Actor | undefined, input: unknown): Promise<{
+    course: Course;
+    revision: string;
+  }>;
+  assertPrerequisiteGraph(courseId: string, prerequisites: string[]): Promise<void>;
+  editableCourse(actor: Actor | undefined, id: string): Promise<{
+    course: Course;
+    revision: string;
+  }>;
+  adminCourses(actor: Actor | undefined, options?: {
+    cursor?: string;
+    limit?: number;
+    status?: string;
+  }): Promise<Page<Course>>;
+  catalog(input: unknown): Promise<Page<CourseCard>>;
+  publicCourse(slug: string): Promise<{
+    prerequisites: {
+      id: string;
+      title: string;
+      slug: string | null;
+    }[];
+    description: string;
+    outcomes: string[];
+    requirements: string[];
+    sequential: boolean;
+    prerequisiteCourseIds: string[];
+    enrollmentClosesAt: string | null;
+    accessDays: number;
+    certificateEnabled: boolean;
+    modules: CurriculumModule[];
+    id: string;
+    slug: string;
+    title: string;
+    summary: string;
+    category: string;
+    tags: string[];
+    level: CourseData["level"];
+    language: string;
+    featuredImage: CourseData["featuredImage"];
+    instructorName: string;
+    enrollmentMode: CourseData["enrollmentMode"];
+    lessonCount: number;
+    durationMinutes: number;
+  }>;
+  detail(course: Course): Promise<{
+    prerequisites: {
+      id: string;
+      title: string;
+      slug: string | null;
+    }[];
+    description: string;
+    outcomes: string[];
+    requirements: string[];
+    sequential: boolean;
+    prerequisiteCourseIds: string[];
+    enrollmentClosesAt: string | null;
+    accessDays: number;
+    certificateEnabled: boolean;
+    modules: CurriculumModule[];
+    id: string;
+    slug: string;
+    title: string;
+    summary: string;
+    category: string;
+    tags: string[];
+    level: CourseData["level"];
+    language: string;
+    featuredImage: CourseData["featuredImage"];
+    instructorName: string;
+    enrollmentMode: CourseData["enrollmentMode"];
+    lessonCount: number;
+    durationMinutes: number;
+  }>;
+  preview(courseId: string, lessonId: string): Promise<{
+    course: CourseDetail;
+    lesson: PublicLesson;
+  }>;
+  resolveContent(lesson: ReturnType<typeof findLesson>): Promise<ReturnType<typeof findLesson>>;
+  assertPrerequisites(course: Course, actorId: string): Promise<void>;
+  newEnrollment(course: Course, actor: Actor, status: Enrollment["status"]): Enrollment;
+  enroll(actor: Actor | undefined, courseId: string, options?: {
+    cohortId?: string;
+  }): Promise<PublicEnrollment>;
+  adminEnrollment(actor: Actor | undefined, input: unknown): Promise<PublicEnrollment>;
+  learnerCourse(actor: Actor | undefined, courseId: string): Promise<{
+    course: {
+      prerequisites: {
+        id: string;
+        title: string;
+        slug: string | null;
+      }[];
+      description: string;
+      outcomes: string[];
+      requirements: string[];
+      sequential: boolean;
+      prerequisiteCourseIds: string[];
+      enrollmentClosesAt: string | null;
+      accessDays: number;
+      certificateEnabled: boolean;
+      modules: CurriculumModule[];
+      id: string;
+      slug: string;
+      title: string;
+      summary: string;
+      category: string;
+      tags: string[];
+      level: CourseData["level"];
+      language: string;
+      featuredImage: CourseData["featuredImage"];
+      instructorName: string;
+      enrollmentMode: CourseData["enrollmentMode"];
+      lessonCount: number;
+      durationMinutes: number;
+    };
+    enrollment: PublicEnrollment | null;
+    progress: ProgressSummary;
+  }>;
+  learnerCourseBySlug(actor: Actor | undefined, slug: string): Promise<{
+    course: {
+      prerequisites: {
+        id: string;
+        title: string;
+        slug: string | null;
+      }[];
+      description: string;
+      outcomes: string[];
+      requirements: string[];
+      sequential: boolean;
+      prerequisiteCourseIds: string[];
+      enrollmentClosesAt: string | null;
+      accessDays: number;
+      certificateEnabled: boolean;
+      modules: CurriculumModule[];
+      id: string;
+      slug: string;
+      title: string;
+      summary: string;
+      category: string;
+      tags: string[];
+      level: CourseData["level"];
+      language: string;
+      featuredImage: CourseData["featuredImage"];
+      instructorName: string;
+      enrollmentMode: CourseData["enrollmentMode"];
+      lessonCount: number;
+      durationMinutes: number;
+    };
+    enrollment: PublicEnrollment | null;
+    progress: ProgressSummary;
+  }>;
+  dashboard(actor: Actor | undefined, options?: {
+    cursor?: string;
+    limit?: number;
+  }): Promise<{
+    items: {
+      course: CourseCard;
+      enrollment: PublicEnrollment;
+      progress: ProgressSummary;
+    }[];
+    cursor?: string;
+    hasMore: boolean;
+  }>;
+  learnerLesson(actor: Actor | undefined, courseId: string, lessonId: string): Promise<{
+    course: CourseDetail;
+    lesson: PublicLesson;
+    enrollment: PublicEnrollment;
+    progress: ProgressSummary;
+  }>;
+  startLesson(actor: Actor | undefined, courseId: string, lessonId: string): Promise<PublicEnrollment>;
+  completeLesson(actor: Actor | undefined, courseId: string, lessonId: string): Promise<{
+    enrollment: PublicEnrollment;
+    progress: ProgressSummary;
+  }>;
+  finish(course: Course, enrollment: Enrollment, settings: LmsSettings): void;
+  projectCompletion(enrollment: Enrollment): Promise<void>;
+  startQuiz(actor: Actor | undefined, courseId: string, lessonId: string): Promise<PublicQuizAttempt>;
+  submitQuiz(actor: Actor | undefined, input: unknown): Promise<{
+    attempt: PublicQuizAttempt;
+    enrollment: PublicEnrollment;
+    progress: ProgressSummary;
+  }>;
+  saveQuizDraft(actor: Actor | undefined, input: unknown): Promise<{
+    saved: boolean;
+  }>;
+  submitAssignment(actor: Actor | undefined, input: unknown): Promise<PublicEnrollment>;
+  gradeAssignment(actor: Actor | undefined, input: unknown): Promise<PublicEnrollment>;
+  saveNote(actor: Actor | undefined, input: unknown): Promise<{
+    note: string;
+  }>;
+  certificate(actor: Actor | undefined, courseId: string): Promise<Certificate>;
+  ownedCertificate(actor: Actor | undefined, id: string): Promise<Certificate>;
+  verifyCertificate(id: string): Promise<{
+    id: string;
+    courseTitle: string;
+    issuerName: string;
+    issuedAt: string;
+    valid: boolean;
+    shared: boolean;
+    learnerName: string | null;
+  }>;
+  shareCertificate(actor: Actor | undefined, courseId: string, shared: boolean): Promise<Certificate>;
+  revokeCertificate(actor: Actor | undefined, courseId: string, userId: string, reason: string): Promise<Certificate>;
+  cancelEnrollment(actor: Actor | undefined, courseId: string): Promise<PublicEnrollment>;
+  discussions(actor: Actor | undefined, courseId: string, lessonId: string, cursor?: string): Promise<{
+    pending: Discussion[];
+    items: Discussion[];
+    cursor?: string;
+    hasMore: boolean;
+  }>;
+  postDiscussion(actor: Actor | undefined, input: unknown): Promise<Discussion>;
+  publicReviews(courseId: string, cursor?: string): Promise<Page<Review>>;
+  postReview(actor: Actor | undefined, input: unknown): Promise<Review>;
+  moderate(actor: Actor | undefined, collection: "reviews" | "discussions", input: unknown): Promise<{
+    status: "published" | "hidden";
+    updatedAt: string;
+    id: string;
+    courseId: string;
+    userId: string;
+    authorName: string;
+    rating: number;
+    body: string;
+    createdAt: string;
+  } | {
+    status: "published" | "hidden";
+    updatedAt: string;
+    id: string;
+    courseId: string;
+    lessonId: string;
+    parentId: string | null;
+    authorId: string;
+    authorName: string;
+    body: string;
+    createdAt: string;
+  }>;
+  communityQueue(actor: Actor | undefined, collection: "reviews" | "discussions", options?: {
+    courseId?: string;
+    cursor?: string;
+    status?: string;
+  }): Promise<{
+    items: ({
+      revision: string;
+      id: string;
+      courseId: string;
+      userId: string;
+      authorName: string;
+      rating: number;
+      body: string;
+      status: "pending" | "published" | "hidden";
+      createdAt: string;
+      updatedAt: string;
+    } | {
+      revision: string;
+      id: string;
+      courseId: string;
+      lessonId: string;
+      parentId: string | null;
+      authorId: string;
+      authorName: string;
+      body: string;
+      status: "pending" | "published" | "hidden";
+      createdAt: string;
+      updatedAt: string;
+    })[];
+    cursor?: string;
+    hasMore: boolean;
+  } | {
+    items: ({
+      revision: string;
+      id: string;
+      courseId: string;
+      userId: string;
+      authorName: string;
+      rating: number;
+      body: string;
+      status: "pending" | "published" | "hidden";
+      createdAt: string;
+      updatedAt: string;
+    } | {
+      revision: string;
+      id: string;
+      courseId: string;
+      lessonId: string;
+      parentId: string | null;
+      authorId: string;
+      authorName: string;
+      body: string;
+      status: "pending" | "published" | "hidden";
+      createdAt: string;
+      updatedAt: string;
+    })[];
+    cursor?: string;
+    hasMore: boolean;
+  }>;
+  enrollments(actor: Actor | undefined, options?: {
+    courseId?: string;
+    status?: string;
+    cursor?: string;
+    limit?: number;
+  }): Promise<{
+    items: {
+      learnerEmail: string;
+      courseTitle: string;
+      lessonTitles: {
+        [k: string]: string;
+      };
+      progressSummary: ProgressSummary | null;
+      effectiveAccess: "pending" | "granted" | "scheduled" | "expired" | "suspended" | "revoked";
+      progress: Record<string, Omit<LessonProgress, "quizAttempts"> & {
+        quizAttempts: PublicQuizAttempt[];
+      }>;
+      id: string;
+      status: "pending" | "active" | "completed" | "rejected" | "suspended" | "cancelled";
+      courseId: string;
+      cohortId: string | null;
+      userId: string;
+      accessStartsAt: string | null;
+      accessExpiresAt: string | null;
+      accessStatus: "pending" | "granted" | "suspended" | "revoked";
+      accessSource: "free" | "manual" | "cohort" | "purchase";
+      enrolledAt: string;
+      completedAt: string | null;
+      lastActivityAt: string;
+      learnerName: string;
+      grants: Record<string, AccessGrant>;
+      cohortIds: string[];
+      acquisition: Acquisition;
+      approvedBy: string | null;
+      decisionAt: string | null;
+      decisionReason: string | null;
+      approvedAt: string | null;
+      certificate: Certificate | null;
+      completionLessonIds: string[];
+      schemaVersion: 1;
+    }[];
+    cursor?: string;
+    hasMore: boolean;
+  }>;
+  report(actor: Actor | undefined, courseId?: string): Promise<{
+    accessSources: any;
+    accessDecisions: any;
+    completionRate: number;
+    courseCount: number;
+    generatedAt: string;
+    total: number;
+    completedEver: number;
+  }>;
+  enrollmentCsv(actor: Actor | undefined, options?: {
+    courseId?: string;
+    status?: string;
+  }): Promise<string>;
+  cohortList(actor: Actor | undefined, cursor?: string): Promise<{
+    items: {
+      revision: string;
+      id: string;
+      createdBy: string;
+      createdAt: string;
+      updatedAt: string;
+      title: string;
+      courseIds: string[];
+      memberIds: string[];
+      startsAt: string | null;
+      endsAt: string | null;
+    }[];
+    cursor?: string;
+    hasMore: boolean;
+  }>;
+  publicCohort(id: string): Promise<{
+    id: string;
+    title: string;
+    startsAt: string | null;
+    endsAt: string | null;
+    courses: CourseCard[];
+  }>;
+  requestCohort(actor: Actor | undefined, cohortId: string): Promise<CohortMembership>;
+  cohortMemberships(actor: Actor | undefined, options?: {
+    cohortId?: string;
+    status?: string;
+    cursor?: string;
+  }): Promise<Page<CohortMembership>>;
+  decideCohort(actor: Actor | undefined, cohortId: string, userId: string, status: "active" | "rejected" | "suspended" | "cancelled", reason?: string): Promise<{
+    membership: CohortMembership;
+    results: {
+      courseId: string;
+      success: boolean;
+      error?: string;
+    }[];
+  }>;
+  saveCohort(actor: Actor | undefined, input: unknown): Promise<{
+    cohort: Cohort;
+    revision: string;
+  }>;
+  applyCohort(actor: Actor | undefined, id: string, expectedRevision: string, offset: number): Promise<{
+    results: {
+      userId: string;
+      courseId: string;
+      success: boolean;
+      error?: string;
+    }[];
+    nextOffset: number;
+    hasMore: boolean;
+  }>;
+  notify(enrollment: Enrollment, key: string, title: string, message: string): Promise<void>;
+  notifications(actor: Actor | undefined, cursor?: string): Promise<{
+    items: {
+      id: string;
+      userId: string;
+      title: string;
+      message: string;
+      courseId: string | null;
+      read: boolean;
+      createdAt: string;
+    }[];
+    cursor?: string;
+    hasMore: boolean;
+  }>;
+  readNotification(actor: Actor | undefined, id: string): Promise<{
+    read: boolean;
+  }>;
+  deliverNotifications(): Promise<{
+    sent: number;
+    failed: number;
+  }>;
+  assignments(actor: Actor | undefined, courseId: string, cursor?: string): Promise<{
+    items: {
+      userId: string;
+      learnerName: string;
+      courseId: string;
+      lessonId: string;
+      id: string;
+      body: string;
+      attachmentUrl: string | null;
+      submittedAt: string;
+      status: "submitted" | "graded";
+      maxPoints: number;
+      passingPoints: number;
+      points: number | null;
+      feedback: string;
+      gradedAt: string | null;
+      gradedBy: string | null;
+    }[];
+    cursor?: string;
+    hasMore: boolean;
+  }>;
+  exportCourse(actor: Actor | undefined, id: string): Promise<{
+    format: string;
+    version: number;
+    course: {
+      slug: string;
+      title: string;
+      summary: string;
+      description: string;
+      outcomes: string[];
+      requirements: string[];
+      category: string;
+      tags: string[];
+      language: string;
+      level: "beginner" | "intermediate" | "advanced" | "all";
+      featuredImage: {
+        id: string;
+        src: string;
+        alt: string;
+      } | null;
+      instructorName: string;
+      instructorIds: string[];
+      status: "draft" | "published" | "archived";
+      enrollmentMode: "open" | "approval" | "invite";
+      commerce: {
+        accessModel: "free" | "paid";
+        offerId: string | null;
+        priceMinor: number | null;
+        currency: string;
+      };
+      prerequisiteCourseIds: string[];
+      sequential: boolean;
+      enrollmentClosesAt: string | null;
+      accessDays: number;
+      certificateEnabled: boolean;
+      modules: {
+        id: string;
+        title: string;
+        description: string;
+        releaseDays: number;
+        unlockAt: string | null;
+        lessons: {
+          id: string;
+          title: string;
+          summary: string;
+          kind: "text" | "video" | "audio" | "quiz" | "assignment" | "live";
+          body: string;
+          portableText: Record<string, unknown>[];
+          contentSource: {
+            collection: string;
+            id: string;
+            field: string;
+          } | null;
+          mediaUrl: string | null;
+          liveStartsAt: string | null;
+          durationMinutes: number;
+          minStudySeconds: number;
+          preview: boolean;
+          required: boolean;
+          resources: {
+            id: string;
+            title: string;
+            url: string;
+            description: string;
+          }[];
+          quiz: {
+            questions: {
+              id: string;
+              type: "single" | "multiple" | "true_false" | "short";
+              prompt: string;
+              options: {
+                id: string;
+                text: string;
+              }[];
+              correctAnswers: string[];
+              points: number;
+              explanation: string;
+            }[];
+            passingPercent: number;
+            maxAttempts: number;
+            timeLimitMinutes: number;
+            randomizeQuestions: boolean;
+            randomizeOptions: boolean;
+            showFeedback: "never" | "after_pass" | "after_submit";
+          } | null;
+          assignment: {
+            instructions: string;
+            maxPoints: number;
+            passingPoints: number;
+            dueAt: string | null;
+            allowResubmission: boolean;
+          } | null;
+        }[];
+      }[];
+    };
+  }>;
+  importCourse(actor: Actor | undefined, input: unknown): Promise<{
+    course: Course;
+    revision: string;
+  }>;
+  deleteCourse(actor: Actor | undefined, id: string, expectedRevision: string): Promise<{
+    deleted: boolean;
+  }>;
+  retryNotification(actor: Actor | undefined, id: string): Promise<{
+    queued: boolean;
+  }>;
+  notificationQueue(actor: Actor | undefined, options?: {
+    status?: Notification["emailStatus"];
+    cursor?: string;
+    limit?: number;
+  }): Promise<Page<Notification>>;
+  auditList(actor: Actor | undefined, options?: {
+    cursor?: string;
+    limit?: number;
+  }): Promise<Page<AuditRecord>>;
+  reminders(): Promise<number>;
+}
+//#endregion
+//#region src/runtime.d.ts
+declare function createPlugin(_options?: LmsOptions): emdash.ResolvedPlugin<{
+  courses: {
+    indexes: string[];
+    uniqueIndexes: string[];
+  };
+  enrollments: {
+    indexes: (string | string[])[];
+  };
+  certificates: {
+    indexes: string[];
+  };
+  discussions: {
+    indexes: (string | string[])[];
+  };
+  reviews: {
+    indexes: string[];
+  };
+  cohorts: {
+    indexes: string[];
+  };
+  cohort_enrollments: {
+    indexes: string[];
+  };
+  notifications: {
+    indexes: string[];
+  };
+  audit: {
+    indexes: string[];
+  };
+}>;
+//#endregion
+export { LmsService, createPlugin };
+//# sourceMappingURL=runtime.d.ts.map