@academy-sdk/sdk 0.1.0 → 0.2.0

package/src/types/bundle.ts

@@ -0,0 +1,119 @@
+export interface BundleSettings {
+  pricingType: 'FREE' | 'ONE_TIME' | 'SUBSCRIPTION' | 'INSTALLMENT';
+  price?: number;
+  currency?: string;
+  accessDurationDays?: number;
+  allowCourseSkipping?: boolean;
+  requireSequentialCompletion?: boolean;
+  enableBundleCertificate?: boolean;
+  trialEnabled?: boolean;
+  trialPrice?: number;
+  trialDurationDays?: number;
+}
+
+export interface Bundle {
+  id: string;
+  tenantId?: string;
+  title: string;
+  slug?: string;
+  description?: string;
+  status: 'DRAFT' | 'PUBLISHED' | 'UNPUBLISHED' | 'ARCHIVED';
+  settings?: BundleSettings;
+  courses?: BundleCourse[];
+  includedCourses?: BundleCourse[];
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface BundleCourse {
+  courseId: string;
+  orderIndex: number;
+  dripType?: 'STUDENT_ENROLLMENT_DATE' | 'STUDENT_START_DATE' | 'SPECIFIC_DATE';
+  dripStartDate?: string;
+  course?: {
+    id: string;
+    title: string;
+    slug?: string;
+    thumbnail?: string;
+    summary?: string;
+    status?: string;
+    sections?: Array<{
+      id: string;
+      title: string;
+      description?: string;
+      activities?: Array<{
+        id: string;
+        title: string;
+        description?: string;
+        estimatedDuration?: string;
+      }>;
+    }>;
+  };
+}
+
+export interface LearnerBundleCourse {
+  id: string;
+  title: string;
+  slug: string;
+  summary?: string;
+  thumbnail?: string;
+  orderIndex: number;
+  status: string;
+  totalActivities: number;
+  isEnrolled: boolean;
+  enrollmentId?: string;
+  enrollmentSource?: string;
+  isAccessible: boolean;
+  isAvailable: boolean;
+  availableAt?: string;
+  dripType?: 'STUDENT_ENROLLMENT_DATE' | 'STUDENT_START_DATE' | 'SPECIFIC_DATE';
+  isCompleted?: boolean;
+  completedAt?: string;
+  progressPercentage?: number;
+  completedActivities?: number;
+}
+
+export interface LearnerBundleCreator {
+  id: string;
+  name: string;
+  email: string;
+}
+
+export interface LearnerBundle {
+  id: string;
+  title: string;
+  slug: string;
+  description?: string;
+  courses: LearnerBundleCourse[];
+  totalCourses: number;
+  totalActivities: number;
+  price?: number | null;
+  currency: string;
+  pricingType: 'FREE' | 'ONE_TIME' | 'SUBSCRIPTION' | 'INSTALLMENT';
+  creator: LearnerBundleCreator;
+  isEnrolled: boolean;
+  createdAt: string;
+  updatedAt: string;
+  allowCourseSkipping: boolean;
+  requireSequentialCompletion: boolean;
+  enableBundleCertificate: boolean;
+  enableDiscussions: boolean;
+  bundleProgressPercentage: number;
+  allCoursesCompleted?: boolean;
+  certificateUrl?: string;
+  trialEnabled?: boolean;
+  trialPrice?: number;
+  trialDurationDays?: number;
+}
+
+export interface BundleListResponse {
+  data: Bundle[];
+  meta: {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+  };
+}

package/src/types/common.ts

@@ -0,0 +1,24 @@
+export interface PaginationMeta {
+  page: number;
+  limit: number;
+  total: number;
+  totalPages: number;
+  hasNextPage: boolean;
+  hasPreviousPage: boolean;
+}
+
+export interface PaginatedResponse<T> {
+  data: T[];
+  meta: PaginationMeta;
+}
+
+export interface PaginationProps {
+  currentPage: number;
+  totalPages: number;
+  total: number;
+  pageSize: number;
+  hasNextPage: boolean;
+  hasPreviousPage: boolean;
+  onPageChange: (page: number) => void;
+  maxVisiblePages?: number;
+}

package/src/types/course.ts

@@ -0,0 +1,135 @@
+export interface Course {
+  id: string;
+  title: string;
+  description?: string;
+  summary?: string;
+  slug?: string;
+  thumbnail?: string;
+  instructorId?: string;
+  status?: string;
+  modules?: Module[];
+  sections?: any[];
+  studentsEnrolled?: number;
+  totalActivities?: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+  timestamp?: string;
+  settings?: CourseSettings;
+}
+
+export interface CourseSettings {
+  dripEnabled?: boolean;
+  timezone?: string;
+  banner?: string;
+  primaryThemeColor?: string;
+  secondaryThemeColor?: string;
+  communityEnabled?: boolean;
+  slackCommunityEnabled?: boolean;
+  slackCommunityStatus?: string;
+  slackChannelId?: string;
+  slackChannelName?: string;
+  seoTitle?: string;
+  seoDescription?: string;
+  seo?: CourseSEOSettings;
+  trialEnabled?: boolean;
+  trialPrice?: number;
+  trialDurationDays?: number;
+}
+
+export interface CourseSEOSettings {
+  title?: string;
+  description?: string;
+  isPubliclyDiscoverable?: boolean;
+  requirePassword?: boolean;
+  coursePassword?: string;
+}
+
+export interface Module {
+  id: string;
+  courseId: string;
+  title: string;
+  description: string;
+  order: number;
+  lessons: Lesson[];
+}
+
+export interface Lesson {
+  id: string;
+  moduleId: string;
+  title: string;
+  description: string;
+  videoUrl?: string;
+  content: string;
+  resources: Resource[];
+  homeworkRequired: boolean;
+  order: number;
+  duration?: number;
+}
+
+export interface Resource {
+  id: string;
+  lessonId: string;
+  title: string;
+  url: string;
+  type: 'pdf' | 'video' | 'link' | 'document';
+}
+
+// Course player types
+export interface CoursePlayerLesson {
+  id: string;
+  title: string;
+  videoUrl: string;
+  videoProvider?: 'YOUTUBE' | 'VIMEO' | 'LOOM' | 'OTHERS';
+  videoResourceId?: string;
+  hasTranscript?: boolean;
+  duration: string;
+  completed: boolean;
+  locked?: boolean;
+  available?: boolean;
+  availableAt?: string;
+  availabilityMessage?: string;
+  schedulingType?: string;
+  remainingDays?: number;
+  hasPrerequisite?: boolean;
+  downloadable?: boolean;
+  lessonIcon?: string;
+  description?: string;
+  summary?: string;
+  learningObjectives?: string[];
+  enableDiscussion?: boolean;
+  secondaryResources?: Array<{
+    id: string;
+    title: string;
+    type: 'VIDEO' | 'LINK' | 'DOCUMENT';
+    metadataJson: {
+      url?: string;
+      key?: string;
+      name?: string;
+      size?: number;
+      mimeType?: string;
+    };
+  }>;
+  progressData?: {
+    progressId?: string;
+    completed?: boolean;
+    lastAccessed?: string;
+    progressSecond?: number;
+    completedAt?: string;
+  };
+  _fullData?: any;
+}
+
+export interface CoursePlayerModule {
+  id: string;
+  title: string;
+  lessons: CoursePlayerLesson[];
+}
+
+export interface CoursePlayerCourse {
+  id: string;
+  title: string;
+  description: string;
+  modules: CoursePlayerModule[];
+  summary?: string;
+  learningObjectives?: string[];
+}

package/src/types/enrollment.ts

@@ -0,0 +1,35 @@
+export interface StudentProgress {
+  id: string;
+  studentId: string;
+  courseId: string;
+  lessonsCompleted: string[];
+  currentLessonId?: string;
+  completionPercentage: number;
+  lastAccessedAt: Date;
+}
+
+export interface CourseEnrollment {
+  id: string;
+  learnerId: string;
+  learnerName: string;
+  learnerEmail: string;
+  learnerAvatar?: string;
+  courseId: string;
+  enrollmentDate: string;
+  status: 'active' | 'inactive' | 'removed' | 'pending';
+  progress: {
+    completedLessons: number;
+    totalLessons: number;
+    percentage: number;
+  };
+  lastAccessedAt?: string;
+}
+
+export interface EnrollmentStatus {
+  isEnrolled: boolean;
+  enrollmentId?: string;
+  enrolledAt?: string;
+  lastActivityId?: string;
+  progress?: number;
+  hasReviewed?: boolean;
+}

package/src/types/index.ts

@@ -0,0 +1,15 @@
+export * from './course';
+export * from './lesson';
+export * from './bundle';
+export * from './user';
+export * from './enrollment';
+export * from './messaging';
+export * from './ai-coach';
+export * from './search';
+export * from './notification';
+export * from './rating';
+export * from './manual-review';
+export * from './payment';
+export * from './common';
+export * from './bookmarks';
+export * from './progress';

package/src/types/lesson.ts

@@ -0,0 +1,106 @@
+export interface LessonContent {
+  id: string;
+  title: string;
+  description: string;
+  videoUrl?: string;
+  videoDuration?: number;
+  resources: LessonResource[];
+  moduleId: string;
+  courseId: string;
+  order: number;
+  createdAt?: string;
+  updatedAt?: string;
+}
+
+export interface LessonResource {
+  id: string;
+  lessonId: string;
+  title: string;
+  url: string;
+  type: 'pdf' | 'video' | 'link' | 'document';
+  size?: number;
+  createdAt?: string;
+}
+
+export interface TranscriptItem {
+  timestamp: string;
+  text: string;
+  startTime: number;
+  endTime?: number;
+}
+
+export interface LessonTranscript {
+  lessonId: string;
+  language: string;
+  items: TranscriptItem[];
+  totalDuration?: number;
+}
+
+export interface TranscriptSearchResult {
+  lessonId: string;
+  matches: TranscriptItem[];
+  totalMatches: number;
+}
+
+export interface LessonProgress {
+  currentTime: number;
+  duration: number;
+  completed: boolean;
+}
+
+export interface LessonNote {
+  id: string;
+  activityId: string;
+  text: string;
+  timestamp?: number;
+  formattedTimestamp?: string;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface FAQItem {
+  id: string;
+  question: string;
+  answer: string;
+}
+
+export interface CreateNotePayload {
+  activityId: string;
+  text: string;
+  timestamp?: number;
+}
+
+export interface UpdateNotePayload {
+  text: string;
+  timestamp?: number;
+}
+
+export interface LessonResources {
+  externalLinks: string[];
+  description: string;
+  customTabs: Array<{ id: string; label: string }>;
+  uploadedFiles?: Array<{
+    id: string;
+    key: string;
+    name: string;
+    size: number;
+    type: string;
+    url?: string;
+    customTitle?: string;
+    customDescription?: string;
+  }>;
+}
+
+export interface LessonData {
+  title: string;
+  videoLinks: Array<{ id: string; url: string; title?: string }>;
+  description: string;
+  settings: Record<string, string | boolean | number> & { faqs?: FAQItem[] };
+  resources?: LessonResources;
+  resourceIds?: {
+    videoResourceIds?: string[];
+    linkResourceIds?: string[];
+    fileResourceIds?: string[];
+  };
+  settingsId?: string;
+}

package/src/types/manual-review.ts

@@ -0,0 +1,116 @@
+export type LearnerManualReviewStatus = 'IN_REVIEW' | 'REQUEST_CHANGE' | 'GRADED';
+
+export type QuestionType = 'SINGLE_CHOICE' | 'MULTIPLE_SELECT' | 'TRUE_FALSE' | 'TEXT' | 'ESSAY';
+
+export interface LearnerManualReviewAssignment {
+  id: string;
+  title: string;
+  courseId: string;
+  courseName: string;
+  totalQuestions: number;
+  totalPoints: number;
+  passingScore: number;
+  isManualReview: boolean;
+}
+
+export interface LearnerManualReviewAnswer {
+  questionId: string;
+  questionText: string;
+  questionType: QuestionType;
+  questionPoints: number;
+  selectedOptionId?: string | null;
+  selectedOptionText?: string | null;
+  selectedOptionIds?: string[];
+  selectedOptions?: Array<{ id: string; text: string }>;
+  answerText?: string | null;
+  isCorrect?: boolean;
+  pointsAwarded?: number;
+}
+
+export interface LearnerManualReviewSubmission {
+  id: string;
+  assignment: LearnerManualReviewAssignment;
+  status: LearnerManualReviewStatus;
+  score: number;
+  passed: boolean | null;
+  totalQuestions: number;
+  correctAnswers: number;
+  wrongAnswers: number;
+  totalPoints: number;
+  pointsAwarded: number;
+  submittedAt: string;
+  startedAt: string;
+  timeTakenMinutes: number;
+  answers: LearnerManualReviewAnswer[];
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface LearnerManualReviewSummary {
+  totalSubmissions: number;
+  gradedSubmissions: number;
+  inReviewSubmissions: number;
+  requestChangeSubmissions: number;
+  averageScore: number;
+  highestScore: number;
+  lowestScore: number;
+  passRate: number;
+  averageTimeTaken: number;
+}
+
+export interface LearnerManualReviewPagination {
+  currentPage: number;
+  itemsPerPage: number;
+  totalItems: number;
+  totalPages: number;
+  hasNextPage: boolean;
+  hasPreviousPage: boolean;
+}
+
+export interface LearnerManualReviewResultsResponse {
+  data: LearnerManualReviewSubmission[];
+  summary: LearnerManualReviewSummary;
+  pagination: LearnerManualReviewPagination;
+}
+
+export interface LearnerManualReviewFilters {
+  courseId?: string;
+  activityId?: string;
+  status?: LearnerManualReviewStatus;
+  minScore?: number;
+  maxScore?: number;
+  passed?: boolean;
+  submittedFrom?: string;
+  submittedTo?: string;
+  search?: string;
+  sortBy?: 'submittedAt' | 'score' | 'status' | 'createdAt';
+  page?: number;
+  limit?: number;
+}
+
+export interface LearnerManualReviewDetailResponse {
+  context: {
+    learner: { id: string; name: string; email: string };
+    assignment: { id: string; title: string; totalPoints: number; totalQuestions: number };
+    course: { id: string; name: string };
+    enrollmentId: string;
+    submittedAt: string;
+    status: LearnerManualReviewStatus;
+    revisionNumber: number;
+  };
+  answers: LearnerManualReviewAnswer[];
+  latestReview?: {
+    score: number;
+    feedbackQuestionIds: string[];
+    additionalFeedback?: string;
+    reviewedAt: string;
+  };
+  revisionHistory: Array<{
+    id: string;
+    revisionNumber: number;
+    status: string;
+    submittedAt: string;
+    score: number;
+    isCurrent: boolean;
+  }>;
+}

package/src/types/messaging.ts

@@ -0,0 +1,109 @@
+export interface MessageParticipant {
+  id: string;
+  name: string;
+  email: string;
+  avatar?: string;
+  role: 'CREATOR' | 'STUDENT';
+}
+
+export interface Message {
+  id: string;
+  conversationId: string;
+  senderId: string;
+  senderName: string;
+  senderRole: 'CREATOR' | 'STUDENT';
+  content: string;
+  timestamp: string;
+  isRead: boolean;
+  isDeletedForMe: boolean;
+  courseContext?: {
+    courseId: string;
+    courseName: string;
+  };
+}
+
+export interface Conversation {
+  id: string;
+  participant: MessageParticipant;
+  lastMessage: {
+    content: string;
+    timestamp: string;
+    senderId: string;
+  };
+  unreadCount: number;
+  isArchived: boolean;
+  courseContext?: {
+    courseId: string;
+    courseName: string;
+    moduleName?: string;
+  };
+}
+
+export interface ConversationMessageItem {
+  id: string;
+  senderRole: string;
+  content: string;
+  isRead: boolean;
+  timestamp: string;
+  context_label?: string;
+}
+
+export interface StudentConversationItem {
+  conversationId: string;
+  creatorName: string;
+  creatorEmail: string;
+  creatorId: string;
+  courseId: string;
+  courseTitle: string;
+  lastMessageAt: string;
+  unreadCount: number;
+  msgs?: ConversationMessageItem[];
+}
+
+export interface StudentConversationsResponse {
+  data: StudentConversationItem[];
+  meta: {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+  };
+}
+
+export interface SendCourseMessagePayload {
+  content: string;
+  conversationId?: string;
+}
+
+export interface SendCourseMessageResponse {
+  conversation: {
+    id: string;
+    studentId: string;
+    creatorId: string;
+    courseId: string;
+    lastMessageId: string;
+    lastMessageAt: string;
+  };
+  message: {
+    id: string;
+    conversationId: string;
+    senderId: string;
+    senderRole: 'CREATOR' | 'STUDENT';
+    content: string;
+    createdAt: string;
+    isRead: boolean;
+  };
+}
+
+export interface UnmessagedCourse {
+  id: string;
+  title: string;
+  creatorId: string;
+}
+
+export interface UnmessagedCoursesResponse {
+  data: UnmessagedCourse[];
+  total: number;
+}

package/src/types/notification.ts

@@ -0,0 +1,30 @@
+export type NotificationType = 'NEW_MESSAGE';
+export type NotificationSenderRole = 'STUDENT' | 'CREATOR';
+
+export interface NotificationSender {
+  id: string;
+  name: string;
+  userRole: NotificationSenderRole;
+}
+
+export interface MessageNotification {
+  id: string;
+  type: NotificationType;
+  conversationId: string;
+  messageId: string;
+  senderId?: string;
+  contextLabel: string;
+  messageContent?: string;
+  readAt?: string | null;
+  createdAt: string;
+  sender?: NotificationSender;
+}
+
+export interface NotificationListMeta {
+  page: number;
+  limit: number;
+  total: number;
+  totalPages: number;
+  hasNextPage: boolean;
+  hasPreviousPage: boolean;
+}