Class ProgressRepository

Data access layer for progress tracking operations.

ProgressRepository

Index

Constructors

Methods

createUserProgress findUserProgressByUserId updateUserProgress upsertUserProgress createLessonCompletion findLessonCompletion findUserLessonCompletions createMultipleLessonCompletions getProgressSummary isLessonCompleted getLessonCompletionStats

Constructors

constructor

new ProgressRepository(prisma: PrismaClient): ProgressRepository
Creates an instance of ProgressRepository.
Parameters
- prisma: PrismaClient
  Prisma client instance for database operations
Returns ProgressRepository
- Defined in src/modules/progress/repositories/progressRepository.ts:79

Methods

createUserProgress

createUserProgress(data: CreateUserProgressDto): Promise<UserProgress>
Creates a new user progress record in the database.
Parameters
- data: CreateUserProgressDto
  User progress data to create
Returns Promise<UserProgress>
Promise resolving to the created progress record

Throws
When user progress already exists (409 CONFLICT) or user not found (404 NOT_FOUND)
- Defined in src/modules/progress/repositories/progressRepository.ts:88

findUserProgressByUserId

findUserProgressByUserId(userId: string): Promise<null | UserProgress>
Retrieves user progress record by user ID.
Parameters
- userId: string
  The unique identifier of the user
Returns Promise<null | UserProgress>
Promise resolving to user progress or null if not found

Throws
When database operation fails (500 INTERNAL_SERVER_ERROR)
- Defined in src/modules/progress/repositories/progressRepository.ts:141

updateUserProgress

updateUserProgress(
userId: string,
updates: UpdateUserProgressDto,
): Promise<UserProgress>
Updates user progress record with specified changes.

Automatically updates the last activity date and handles lesson relationship updates.
Parameters
- userId: string
  The unique identifier of the user
- updates: UpdateUserProgressDto
  Object containing fields to update
Returns Promise<UserProgress>
Promise resolving to the updated progress record

Throws
When user progress not found (404 NOT_FOUND) or database operation fails
- Defined in src/modules/progress/repositories/progressRepository.ts:170

upsertUserProgress

upsertUserProgress(data: CreateUserProgressDto): Promise<UserProgress>
Creates new user progress or updates existing record atomically (upsert operation).

This method provides atomic create-or-update functionality, ensuring data consistency when the existence of user progress is uncertain.
Parameters
- data: CreateUserProgressDto
  User progress data for creation or update
Returns Promise<UserProgress>
Promise resolving to the created or updated progress record

Throws
When user not found (404 NOT_FOUND) or database operation fails
- Defined in src/modules/progress/repositories/progressRepository.ts:233

createLessonCompletion

createLessonCompletion(
data: CreateLessonCompletionDto,
): Promise<LessonCompletion>
Creates a new lesson completion record in the database.
Parameters
- data: CreateLessonCompletionDto
  Lesson completion data to create
Returns Promise<LessonCompletion>
Promise resolving to the created completion record

Throws
When lesson already completed (409 CONFLICT), user/lesson not found (404 NOT_FOUND), or database operation fails
- Defined in src/modules/progress/repositories/progressRepository.ts:296

findLessonCompletion

findLessonCompletion(
userId: string,
lessonId: string,
): Promise<null | LessonCompletion>
Retrieves a specific lesson completion record by user and lesson ID.
Parameters
- userId: string
  The unique identifier of the user
- lessonId: string
  The unique identifier of the lesson
Returns Promise<null | LessonCompletion>
Promise resolving to completion record or null if not found

Throws
When database operation fails (500 INTERNAL_SERVER_ERROR)
- Defined in src/modules/progress/repositories/progressRepository.ts:351

findUserLessonCompletions

findUserLessonCompletions(
userId: string,
options?: QueryOptions,
): Promise<PaginatedResult<LessonCompletion>>
Retrieves paginated list of lesson completions for a specific user.

Supports pagination, sorting, and filtering options for efficient data retrieval.
Parameters
- userId: string
  The unique identifier of the user
- Optionaloptions: QueryOptions = {}
  Query options including pagination and sorting parameters
Returns Promise<PaginatedResult<LessonCompletion>>
Promise resolving to paginated completion results

Throws
When database operation fails (500 INTERNAL_SERVER_ERROR)
- Defined in src/modules/progress/repositories/progressRepository.ts:392

createMultipleLessonCompletions

createMultipleLessonCompletions(
completions: CreateLessonCompletionDto[],
): Promise<LessonCompletion[]>
Creates multiple lesson completion records atomically within a transaction.

This method is optimized for offline synchronization scenarios, automatically skipping duplicate completions and ensuring data consistency through transaction handling.
Parameters
- completions: CreateLessonCompletionDto[]
  Array of lesson completion data to create
Returns Promise<LessonCompletion[]>
Promise resolving to array of successfully created completion records

Throws
When database operation fails (500 INTERNAL_SERVER_ERROR)
- Defined in src/modules/progress/repositories/progressRepository.ts:457

getProgressSummary

getProgressSummary(userId: string): Promise<null | ProgressSummary>
Retrieves comprehensive progress summary with aggregated statistics.

Calculates lessons completed, courses started, and other analytics data by performing complex queries across multiple related tables. Includes advanced analytics like longest streak, completion percentage, and average score.
Parameters
- userId: string
  The unique identifier of the user
Returns Promise<null | ProgressSummary>
Promise resolving to progress summary or null if user progress not found

Throws
When database operation fails (500 INTERNAL_SERVER_ERROR)
- Defined in src/modules/progress/repositories/progressRepository.ts:521

isLessonCompleted

isLessonCompleted(userId: string, lessonId: string): Promise<boolean>
Checks whether a specific lesson has been completed by the user.
Parameters
- userId: string
  The unique identifier of the user
- lessonId: string
  The unique identifier of the lesson
Returns Promise<boolean>
Promise resolving to true if lesson is completed, false otherwise

Throws
When database operation fails (500 INTERNAL_SERVER_ERROR)
- Defined in src/modules/progress/repositories/progressRepository.ts:619

getLessonCompletionStats

getLessonCompletionStats(
    lessonId: string,
): Promise<
    {
        total_completions: number;
        average_score: null
        | number;
        average_time_spent: null | number;
    },
>
Retrieves aggregated completion statistics for a specific lesson.

Calculates total completions, average score, and average time spent using database aggregation functions.
Parameters
- lessonId: string
  The unique identifier of the lesson
Returns Promise<
    {
        total_completions: number;
        average_score: null
        | number;
        average_time_spent: null | number;
    },
>
Promise resolving to lesson completion statistics

Throws
When database operation fails (500 INTERNAL_SERVER_ERROR)
- Defined in src/modules/progress/repositories/progressRepository.ts:655

Class ProgressRepository

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ProgressRepository

Methods

createUserProgress

Parameters

Returns Promise<UserProgress>

Throws

findUserProgressByUserId

Parameters

Returns Promise<null | UserProgress>

Throws

updateUserProgress

Parameters

Returns Promise<UserProgress>

Throws

upsertUserProgress

Parameters

Returns Promise<UserProgress>

Throws

createLessonCompletion

Parameters

Returns Promise<LessonCompletion>

Throws

findLessonCompletion

Parameters

Returns Promise<null | LessonCompletion>

Throws

findUserLessonCompletions

Parameters

Returns Promise<PaginatedResult<LessonCompletion>>

Throws

createMultipleLessonCompletions

Parameters

Returns Promise<LessonCompletion[]>

Throws

getProgressSummary

Parameters

Returns Promise<null | ProgressSummary>

Throws

isLessonCompleted

Parameters

Returns Promise<boolean>

Throws

getLessonCompletionStats

Parameters

Returns Promise< { total_completions: number; average_score: null | number; average_time_spent: null | number; },>

Throws

Settings

On This Page

Returns Promise<
{
total_completions: number;
average_score: null
| number;
average_time_spent: null | number;
},
>