@anantagnanam/lms 0.0.0-stage → 0.2.0

package/dist/types.d.ts

@@ -0,0 +1,387 @@
+import { cohortDataSchema, courseDataSchema, lessonSchema, moduleSchema, pathDataSchema, preferencesSchema, questionSchema, quizSchema, settingsSchema } from "./schemas.js";
+import { z } from "zod";
+
+//#region src/types.d.ts
+type CourseData = z.infer<typeof courseDataSchema>;
+type CourseModule = z.infer<typeof moduleSchema>;
+type Lesson = z.infer<typeof lessonSchema>;
+type QuizQuestion = z.infer<typeof questionSchema>;
+type Quiz = z.infer<typeof quizSchema>;
+type LmsSettings = z.infer<typeof settingsSchema>;
+interface Course extends CourseData {
+  id: string;
+  searchTitle: string;
+  createdBy: string;
+  createdAt: string;
+  updatedAt: string;
+  schemaVersion: 1 | 2;
+  draftRevisionId?: string;
+  publishedEditionId?: string;
+  publishedDraftRevisionId?: string;
+  legacyEditionId?: string;
+}
+interface CourseRevision {
+  id: string;
+  courseId: string;
+  parentId: string | null;
+  data: CourseData;
+  kind: "migration" | "draft" | "publish" | "restore" | "archive";
+  createdBy: string;
+  createdAt: string;
+  editionId?: string;
+  restoredFrom?: string;
+}
+type RevisionSummary = Omit<CourseRevision, "data"> & {
+  title: string;
+};
+interface CourseEdition {
+  id: string;
+  courseId: string;
+  data: CourseData;
+  createdAt: string;
+}
+interface MigrationState {
+  phase: "courses" | "enrollments" | "complete";
+  cursor?: string;
+  coursesProcessed: number;
+  enrollmentsProcessed: number;
+  updatedAt: string;
+  lastError: string | null;
+}
+interface Actor {
+  id: string;
+  email: string;
+  name: string | null;
+  role: number;
+}
+interface Versioned<T> {
+  value: T;
+  revision: string;
+}
+type Answers = Record<string, string | string[]>;
+type PublicQuestion = Omit<QuizQuestion, "correctAnswers" | "explanation">;
+interface QuestionResult {
+  questionId: string;
+  correct: boolean;
+  points: number;
+  maxPoints: number;
+  explanation?: string;
+}
+interface QuizAttempt {
+  id: string;
+  startedAt: string;
+  expiresAt: string | null;
+  status: "in_progress" | "submitted" | "expired";
+  quiz: Quiz | null;
+  questions: PublicQuestion[];
+  submittedAt: string | null;
+  score: number | null;
+  maxScore: number | null;
+  percent: number | null;
+  passed: boolean;
+  feedback: QuestionResult[];
+  answers: Answers;
+  /** Records created before draft fencing have revision zero. */
+  draftRevision?: number;
+}
+type PublicQuizAttempt = Omit<QuizAttempt, "quiz" | "draftRevision"> & {
+  draftRevision: number;
+};
+interface AssignmentSubmission {
+  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;
+}
+interface LessonProgress {
+  startedAt: string | null;
+  completedAt: string | null;
+  note: string;
+  quizAttempts: QuizAttempt[];
+  assignments: AssignmentSubmission[];
+  playback?: Playback;
+}
+interface Playback {
+  positionSeconds: number;
+  playbackRate: number;
+  revision: number;
+  updatedAt: string;
+}
+type LearnerPreferences = z.infer<typeof preferencesSchema>;
+interface SavedCourse {
+  userId: string;
+  courseId: string;
+  saved: boolean;
+  updatedAt: string;
+}
+interface LearningPath extends z.infer<typeof pathDataSchema> {
+  id: string;
+  createdAt: string;
+  updatedAt: string;
+}
+interface PathEnrollment {
+  pathId: string;
+  userId: string;
+  title: string;
+  courseIds: string[];
+  joinedAt: string;
+}
+interface PublicPath {
+  id: string;
+  title: string;
+  description: string;
+  courses: (CourseCard | null)[];
+}
+interface LearnerPath {
+  pathId: string;
+  title: string;
+  joinedAt: string;
+  completed: number;
+  total: number;
+  courses: {
+    course: CourseCard | null;
+    completed: boolean;
+  }[];
+}
+interface LmsHealth {
+  version: string;
+  maintenance: {
+    startedAt: string;
+    completedAt: string | null;
+    failed: boolean;
+  } | null;
+  maintenanceStale: boolean;
+  pendingEmails: number;
+  failedEmails: number;
+  oldestPendingAt: string | null;
+  emailEnabled: boolean;
+  migration: MigrationState | null;
+}
+interface Certificate {
+  id: string;
+  courseId: string;
+  courseTitle: string;
+  userId: string;
+  learnerName: string;
+  issuerName: string;
+  issuedAt: string;
+  shared: boolean;
+  revokedAt: string | null;
+  revocationReason: string | null;
+}
+interface Enrollment {
+  id: string;
+  courseId: string;
+  /** Immutable curriculum selected at enrollment; v1 records use the course's legacy edition. */
+  courseEditionId?: string;
+  userId: string;
+  learnerName: string;
+  learnerEmail: string;
+  status: "pending" | "active" | "completed" | "rejected" | "suspended" | "cancelled";
+  accessStatus: "pending" | "granted" | "suspended" | "revoked";
+  accessSource: "free" | "manual" | "cohort" | "purchase";
+  grants: Record<string, AccessGrant>;
+  cohortIds: string[];
+  acquisition: Acquisition;
+  approvedBy: string | null;
+  decisionAt: string | null;
+  decisionReason: string | null;
+  enrolledAt: string;
+  approvedAt: string | null;
+  completedAt: string | null;
+  accessStartsAt: string | null;
+  accessExpiresAt: string | null;
+  cohortId: string | null;
+  progress: Record<string, LessonProgress>;
+  certificate: Certificate | null;
+  completionLessonIds: string[];
+  lastActivityAt: string;
+  schemaVersion: 1;
+}
+interface Acquisition {
+  orderId: string | null;
+  offerId: string | null;
+  paymentStatus: "not_required" | "pending" | "paid" | "partially_refunded" | "refunded" | "cancelled";
+  amountMinor: number | null;
+  currency: string | null;
+  providerId: string | null;
+  providerPaymentId: string | null;
+}
+interface AccessGrant {
+  id: string;
+  source: Enrollment["accessSource"];
+  referenceId: string | null;
+  status: "pending" | "granted" | "suspended" | "revoked";
+  startsAt: string | null;
+  expiresAt: string | null;
+  grantedBy: string | null;
+  grantedAt: string | null;
+}
+interface PublicEnrollment extends Omit<Enrollment, "learnerEmail" | "progress"> {
+  effectiveAccess: "pending" | "granted" | "scheduled" | "expired" | "suspended" | "revoked";
+  progress: Record<string, Omit<LessonProgress, "quizAttempts"> & {
+    quizAttempts: PublicQuizAttempt[];
+  }>;
+}
+interface CertificateIndex {
+  enrollmentId: string;
+  userId: string;
+  courseId: string;
+}
+interface Discussion {
+  id: string;
+  courseId: string;
+  lessonId: string;
+  parentId: string | null;
+  authorId: string;
+  authorName: string;
+  body: string;
+  status: "pending" | "published" | "hidden";
+  createdAt: string;
+  updatedAt: string;
+}
+interface Review {
+  id: string;
+  courseId: string;
+  userId: string;
+  authorName: string;
+  rating: number;
+  body: string;
+  status: "pending" | "published" | "hidden";
+  createdAt: string;
+  updatedAt: string;
+}
+interface Cohort extends z.infer<typeof cohortDataSchema> {
+  id: string;
+  createdBy: string;
+  createdAt: string;
+  updatedAt: string;
+}
+interface CohortMembership {
+  id: string;
+  cohortId: string;
+  userId: string;
+  learnerName: string;
+  learnerEmail: string;
+  status: "pending" | "active" | "rejected" | "suspended" | "cancelled";
+  requestedAt: string;
+  decidedAt: string | null;
+  decidedBy: string | null;
+  reason: string | null;
+}
+interface Notification {
+  id: string;
+  userId: string;
+  email: string;
+  title: string;
+  message: string;
+  courseId: string | null;
+  read: boolean;
+  createdAt: string;
+  emailStatus: "pending" | "sending" | "sent" | "disabled" | "failed";
+  emailAttempts: number;
+  claimedAt: string | null;
+}
+interface AuditRecord {
+  id: string;
+  actorId: string;
+  action: string;
+  resourceId: string;
+  createdAt: string;
+  details: Record<string, unknown>;
+}
+interface CourseCard {
+  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;
+}
+interface CurriculumLesson {
+  id: string;
+  title: string;
+  summary: string;
+  kind: Lesson["kind"];
+  durationMinutes: number;
+  preview: boolean;
+  required: boolean;
+}
+interface CurriculumModule {
+  id: string;
+  title: string;
+  description: string;
+  releaseDays: number;
+  unlockAt: string | null;
+  lessons: CurriculumLesson[];
+}
+interface CourseDetail extends CourseCard {
+  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[];
+}
+interface PublicLesson extends Omit<Lesson, "quiz" | "contentSource"> {
+  quiz: (Omit<Quiz, "questions"> & {
+    questionCount: number;
+  }) | null;
+}
+interface Page<T> {
+  items: T[];
+  cursor?: string;
+  hasMore: boolean;
+}
+interface ProgressSummary {
+  completed: number;
+  total: number;
+  percent: number;
+  nextLessonId: string | null;
+  blockedLessonId: string | null;
+  availability: Record<string, LessonAvailability>;
+}
+interface LessonAvailability {
+  available: boolean;
+  code: string | null;
+  reason: string | null;
+  releaseAt: string | null;
+}
+interface LmsOptions {
+  basePath?: string;
+  loginPath?: string;
+}
+interface RouteEnvelope<T> {
+  success: boolean;
+  data?: T;
+  status?: number;
+  error?: {
+    code: string;
+    message: string;
+  };
+}
+//#endregion
+export { AccessGrant, Acquisition, Actor, Answers, AssignmentSubmission, AuditRecord, Certificate, CertificateIndex, Cohort, CohortMembership, Course, CourseCard, CourseData, CourseDetail, CourseEdition, CourseModule, CourseRevision, CurriculumLesson, CurriculumModule, Discussion, Enrollment, LearnerPath, LearnerPreferences, LearningPath, Lesson, LessonAvailability, LessonProgress, LmsHealth, LmsOptions, LmsSettings, MigrationState, Notification, Page, PathEnrollment, Playback, ProgressSummary, PublicEnrollment, PublicLesson, PublicPath, PublicQuestion, PublicQuizAttempt, QuestionResult, Quiz, QuizAttempt, QuizQuestion, Review, RevisionSummary, RouteEnvelope, SavedCourse, Versioned };
+//# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,6 +1,85 @@
 {
   "name": "@anantagnanam/lms",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Courses, assessments, enrollment, progress, certificates and learning communities for EmDash CMS.",
+  "type": "module",
+  "license": "MIT",
+  "homepage": "https://github.com/anantagnanam/anantagnanam-emdash-plugins#readme",
+  "bugs": "https://github.com/anantagnanam/anantagnanam-emdash-plugins/issues",
+  "keywords": [
+    "emdash",
+    "astro",
+    "lms",
+    "courses",
+    "education",
+    "anantagnanam"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anantagnanam/anantagnanam-emdash-plugins.git",
+    "directory": "packages/lms"
+  },
+  "files": [
+    "dist",
+    "astro",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./runtime": {
+      "types": "./dist/runtime.d.ts",
+      "import": "./dist/runtime.js"
+    },
+    "./admin": {
+      "types": "./dist/admin.d.ts",
+      "import": "./dist/admin.js"
+    },
+    "./astro": {
+      "types": "./dist/astro.d.ts",
+      "import": "./dist/astro.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "import": "./dist/server.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.js"
+    },
+    "./schemas": {
+      "types": "./dist/schemas.d.ts",
+      "import": "./dist/schemas.js"
+    },
+    "./commerce": {
+      "types": "./dist/commerce.d.ts",
+      "import": "./dist/commerce.js"
+    },
+    "./components": "./astro/components/index.ts",
+    "./styles.css": "./astro/styles.css"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch --no-clean",
+    "typecheck": "tsc -p tsconfig.json",
+    "prepack": "npm run build"
+  },
+  "engines": {
+    "node": ">=22.16.0"
+  },
+  "peerDependencies": {
+    "emdash": ">=1.4.0 <2",
+    "astro": ">=7.0.0 <8",
+    "react": ">=19.0.0 <20"
+  },
+  "dependencies": {
+    "zod": "^4.6.7"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}