feat: complete rewrite of course (#622)

* theming improvements

* border style improvements

* refactor: migrate org routes to server-side data fetching

Move client-side API calls to server-side load functions for better
performance, security, and SEO. Implement permission-based course filtering

* refactor: clean up course and community components

This commit removes unused components and files related to courses and community features, streamlining the codebase. It also updates various routes to enhance performance and maintainability. Additionally, it introduces new types and constants for better type safety and organization.

* refactor: fix video formatting on website and other styles

* refactor: update course and dashboard components for improved styling and functionality

* more icon improvements

* refactor: streamline course and dashboard components

This commit updates various course and dashboard components for improved styling and functionality. It includes the removal of unused files, updates to imports and exports, and enhancements to type safety. Additionally, it introduces new routes and optimizes existing ones for better performance and maintainability.

* refactor: enhance lesson completion logic

* chore: delete all emails on dashboard and move other api routes to backend.

move all emails to the backend and

* feat: Refactor API and database queries for courses, quizzes, and lessons, migrating Supabase functions and schema management.

* get app loading

* fix ui and build error of cio/api

* refactor: move direct database queries to query layer

- Create query functions: getCourseWithOrgData, getOrganizationByCourseId, updateCourseVersion, updateLessonsSectionId, getProfileByGroupMemberId, getQuestionTypesByIds
- Refactor services to use query functions instead of direct db queries
- Add transaction support to updateCourseVersion and updateLessonsSectionId
- Fix getProfileByGroupMemberId to return profile directly (not nested)
- Fix updateLessonsSectionId to use .returning() instead of rowCount

This aligns services with architecture pattern where services orchestrate queries rather than executing them directly.

* exercise saving improvements

* fix and optimise exercise creation

* refactor: update dialog components for improved styling and functionality

- Adjusted dialog content width and maximum constraints for better responsiveness.
- Changed heading font size for consistency in the new exercise modal.
- Replaced CloseIcon with CrossIcon for a more modern appearance in dialog close button.

* refactor: enhance course and exercise management components

- Introduced new components for exercise creation, editing, and viewing, improving user experience.
- Refactored existing lesson and exercise components for better organization and maintainability.
- Updated routing for exercises and lessons to streamline navigation within the course structure.
- Added new utility functions and constants to support content management across the application.

* feat: implement course content management API and UI components

- Added new API routes for updating and deleting course content, enhancing content management capabilities.
- Introduced new Svelte components for displaying and managing course content, including content lists and action handlers.
- Updated existing course routing to integrate new content management features.
- Refactored content-related utility functions for improved organization and maintainability.

* refactor: remove Supabase references and implement course section management

- Removed Supabase-related environment variables and Dockerfile arguments to streamline configuration.
- Introduced a new section management API with routes for creating, updating, deleting, and reordering course sections.
- Updated course services to handle section operations, ensuring consistency in course content management.
- Refactored existing lesson section logic to align with the new course section structure, enhancing maintainability.

* chore: update .prettierignore to exclude additional file types

- Added exclusions for SQL and environment files to the Prettier ignore list.
- Included Dockerfile and .prettierignore itself to prevent formatting issues.

* feat: enhance course content management with translation support and UI improvements

- Added translation keys for user-facing text in course-related components, ensuring all UI copy is sourced from translation files.
- Updated lesson and exercise creation components to utilize translation keys for success and error messages, improving localization.
- Refactored course content management components to streamline the creation and editing process, enhancing user experience.
- Introduced new constants for content options and stepper states to standardize component behavior and improve maintainability.
- Improved styling and functionality of course content modals and steppers for better user interaction.

* feat: enhance course content management and UI components

- Updated .prettierignore to exclude storybook-static directory.
- Improved exercise creation logic by refining option handling and adding UUID support for option values.
- Enhanced navigation component with debugging output for custom links.
- Introduced a new method in CourseApi to update content items locally, improving state management during navigation.
- Added caching for exercise templates by tag in ExerciseTemplateApi to optimize performance.
- Refactored lesson and exercise components for better organization and maintainability, including updates to modal styling and functionality.
- Implemented local patching for lesson and exercise list items to ensure UI consistency after updates.

* student + teacher invite (not fully tested)

* refactor: streamline course team member middleware

- Removed unnecessary console logging and timing for checking user permissions.
- Simplified the logic for determining if a user is a course team member or organization admin.

* reorder course sidebar to move content to its own page.

* feat: implement unified course enrollment route and API

- Introduced a new enrollment route `/course/:slug/enroll` to replace the previous invite system.
- Unified enrollment logic for free and paid courses, allowing direct enrollment for free courses and invite token validation for paid courses.
- Updated course landing page to redirect to the new enrollment route for free courses.
- Removed obsolete invite routes and related logic, streamlining the enrollment process.
- Enhanced API with a new `POST /course/:courseId/enroll` endpoint for handling enrollments.
- Added rate limiting for enrollment requests to prevent abuse.
- Updated UI components to reflect changes in enrollment flow and messaging.

* chore: update docker stack, docs, and auth token automation

* chore: make prettier check ignore unknown file types

* fix: avoid using authClient on server file and keep authClient client focused

* chore: always get the server on demand depending on the environment

* chore: update dashboard configuration and Docker setup for environment variables

- Modified the Svelte configuration to directly use the PUBLIC_SERVER_URL environment variable.
- Enhanced the Docker Compose file to include health check formatting and added environment variable arguments for the dashboard build.
- Updated the Dockerfile to echo environment variable values during the build process, ensuring clarity on the configuration being used.

* chore: enhance Docker setup and documentation for production deployment

- Added a new production Docker Compose file and example environment file for published images.
- Updated README and usage documentation to include instructions for deploying with production images.
- Modified Svelte configuration to standardize the use of the posthog domain.
- Removed unnecessary console logs from the API client and layout server files for cleaner output.
- Improved overall clarity in Docker documentation regarding self-hosting and image publishing.

* chore(db): log function name in query catch blocks (console.error 'funcName error:', error)

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix: multiple refresh issue

* fix: server key not passed to api

* fix: clarify usage of PRIVATE_SERVER_KEY and AUTH_BEARER_TOKEN in documentation

- Updated documentation to specify that PRIVATE_SERVER_KEY is used for server-to-server API key authentication and is validated by API key middleware.
- Clarified that AUTH_BEARER_TOKEN is a separate token not utilized by apiKeyMiddleware.
- Adjusted examples in Docker setup and self-hosting documentation to reflect these changes.

* fix migration script

* fix: improve language handling and add database reset script

- Updated language extraction to handle potential undefined values, defaulting to 'en' if necessary.
- Added a new script for resetting the database, including functionality to truncate public tables and run setup with optional seeding.

* feat: add promote ungrouped section functionality and enhance document handling in dashboard

- Implemented a new API endpoint to promote synthetic "Ungrouped" content into a real persisted section, allowing for better organization of course materials.
- Updated the dashboard to include a new component for displaying content count badges for lessons and exercises.
- Enhanced document management features, including a new document card component with dropdown actions for viewing, downloading, and removing documents.
- Improved file upload handling with a dedicated file drop zone and error handling for file type and size restrictions.
- Refactored existing components for better readability and maintainability, including updates to lesson and document lists.

* chore: use root env file for docker compose

* docs: document docker no-build startup flow

* chore: add no-build option to docker full stack script

* fix(email): handle SMTP TLS mode by port

* feat(auth): add configurable cookie domain env and docs

* apps/dashboard/src/lib/utils/services/auth/session.ts

* fix(email): make sender configurable via SMTP_SENDER

* chore(i18n): regenerate locale translations and support language targeting

* chore(config): switch api to PUBLIC_SERVER_URL

* fix(i18n): persist selected locale across navigation

* feat(assets): implement organization asset management routes and services

- Added new routes for managing organization assets, including listing, creating, updating, deleting, and exporting assets.
- Introduced asset-related services for handling asset operations such as creation, retrieval, and deletion.
- Integrated YouTube metadata resolution and asset attachment/detachment functionalities.
- Updated organization routes to include the new asset management routes.
- Enhanced error handling for asset-related operations.

* fix(document-list): update conditional rendering for edit mode in document list

* debug self hosted layout setup

* refactor(sidebar): simplify lms sidebar footer and improve navigation item rendering

* feat: tags

* chore: tags roadmap + translations

* fix(api): add authMiddleware to exercise, invites, and content routers

- exerciseRouter: apply authMiddleware before courseMemberMiddleware on all 10 routes
- invitesRouter: apply authMiddleware before courseTeamMemberMiddleware on all 4 routes
- contentRouter: add authMiddleware to PUT route (DELETE already had it)

Both courseMemberMiddleware and courseTeamMemberMiddleware document requiring
authMiddleware to be applied first. This aligns with lessonRouter pattern and
ensures explicit middleware contract regardless of global session middleware.

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* fix(course): use courseTeamMemberMiddleware for PUT, DELETE, and analytics routes

These routes require admin/tutor role per JSDoc but were using
courseMemberMiddleware which allows any course member including students.
Switch to courseTeamMemberMiddleware to restrict access to ADMIN/TUTOR
group members and org admins.

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* chore: unify pricing component between dashboard and website (#630)

* feat: modularize pricing card

* feat: initia implementation of pricing togge

* fix: minor amendment

* refactor: update pricing components for improved layout and styling

- Adjusted spacing in the pricing card layout for better visual consistency.
- Modified button styles and sizes for enhanced usability.
- Cleaned up the pricing toggle component by removing unnecessary console logs and restructuring the button rendering logic.

* add handle click

* chore(css): update Tailwind CSS output with new utility classes and theme variables

* fix(api): enable orgMemberMiddleware for stats route

This change ensures that the stats route is protected by orgMemberMiddleware, aligning access control with other routes. Additionally, removed unnecessary console log from the layout server file to clean up the code.

---------

Co-authored-by: Rotimi Best <best@classroomio.com>

* pass query parameter to signup from pricing page

* ui updates to pricing cards

* commit all PRDs

* add open api spec to api prd

* make blue default theme

* more prds

* sync option id sequence on question update

* docs: more classroomio features

* chore: more ui improvements

* docs: new component docs

* chore: CSP Configuration (#638)

* feat(validation): add GitHub repository name validation

- Add ZRepositoryName schema for validating GitHub repo names
- Add ZRepositoryOwner for owner/username validation
- Add ZRepositoryIdentifier for owner/repo format
- Follow GitHub rules: A-Za-z0-9_.-, 1-100 chars, reserved names
- Add translation keys for validation messages

Fixes #637

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* Revert "feat(validation): add GitHub repository name validation"

This reverts commit 3436536bb17a0f05b3a9fe8dd7682cde64dd1dce.

* feat(dashboard): make CSP external domains configurable via env

Move hardcoded external domains from svelte.config.js to .env configuration
for on-premise deployments with strict security policies, data residency
constraints, or CISO-driven allowlists.

- ALLOWED_EXTERNAL_DOMAINS: single list for all CSP directives
- CSP_SCRIPT_SRC_DOMAINS, CSP_STYLE_SRC_DOMAINS, CSP_CONNECT_SRC_DOMAINS,
  CSP_FRAME_SRC_DOMAINS, CSP_FONT_SRC_DOMAINS: per-directive override
- When unset, defaults retain current SaaS behavior (backward compatible)

Fixes #637

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* fix(dashboard): self-hosted CSP uses only env vars, no defaults

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* fix(dashboard): add all classroomio.com domains to CSP defaults

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* docs: add CSP ALLOWED_EXTERNAL_DOMAINS to self-hosting guides

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* feat(docker): pass CSP domain env vars as build args to dashboard

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* feat: add SSO and token authentication routes and services

- Introduced new routes for SSO and token authentication under the organization namespace.
- Implemented SSO connection management including creation, update, activation, and deletion.
- Added token authentication configuration with support for secret rotation and status retrieval.
- Enhanced error handling for SSO and token authentication processes.
- Updated existing routes and services to integrate new functionalities.
- Improved gradebook service to fetch student marks and exercises.
- Refactored API structure for better organization and maintainability.

* update translations

* fix: add PUBLIC_SERVER_URL to .env.example to prevent localhost fallback in production (#641)

Co-authored-by: Cursor Agent <cursoragent@cursor.com>

* feat: new exercise question types

* MinIO S3 storage backend (#639)

* feat(storage): add MinIO/S3-compatible object storage backend

- Add OBJECT_STORAGE_* env vars for generic S3-compatible backends (MinIO, AWS S3)
- Create storage config module with Cloudflare R2 fallback for backward compatibility
- Refactor s3.ts to use configurable client and bucket names from config
- Update media.ts to use provider-neutral public URL (OBJECT_STORAGE_MEDIA_PUBLIC_BASE_URL or CLOUDFLARE_IMAGE_BUCKET_DOMAIN)
- Add MinIO service and init to docker-compose (profile: minio) with videos/documents/media buckets
- Add localhost:9000 to dashboard CSP for local MinIO presigned URL uploads
- Update self-hosting and Cloudflare docs with MinIO option
- Update .env examples and docker USAGE.md

Fixes #635

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* docs: add MINIO_ROOT_USER and MINIO_ROOT_PASSWORD to self-hosting guides

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* feat(media): refactor media management and integrate MinIO support

- Updated media API to use a new `mediaApi` module, replacing `mediaManagerApi` references across components.
- Added MinIO configuration options to the Docker setup, allowing for optional object storage exclusion.
- Enhanced environment variable management for MinIO in the `.env.example` file.
- Updated Content Security Policy (CSP) to allow local MinIO access in the dashboard.
- Introduced new media components for asset management, including asset cards and usage dialogs.

This refactor improves the modularity of the media handling system and provides better support for S3-compatible storage solutions.

* feat(dashboard): enhance logging and refactor auth session handling

- Added console logging for event and environment variables in hooks.server.ts to aid debugging.
- Refactored auth session handling to use authServerClient instead of authClient in session.ts for improved consistency.
- Updated Dockerfile to ensure the dashboard build output is present before starting the application.
- Expanded self-hosting documentation to include troubleshooting steps for disk space issues in PostgreSQL and Docker.

These changes improve the observability of the application and streamline the authentication process.

* refactor(dashboard): remove debug logging and enhance Postgres healthcheck

- Removed console logging for event and environment variables in hooks.server.ts to clean up the code.
- Updated Postgres healthcheck in docker-compose.yaml to require a successful `SELECT 1` query, ensuring dependent services only start once the database is ready.
- Expanded self-hosting documentation to include troubleshooting steps for database recovery issues.

These changes improve code clarity and reliability in service startup sequences.

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* feat: add Plyr media player icons and PDF.js integration

- Introduced new Plyr SVG icons for media player controls in both course and dashboard applications.
- Updated Plyr player configuration to use local icon assets.
- Integrated PDF.js for document viewing, replacing external CDN links with local paths for improved performance and reliability.
- Enhanced PDF viewer modal z-index for better visibility.

This update improves the media player experience and ensures consistent access to necessary resources.

* feat: enhance account and organization services with type definitions and promise return types

- Updated `getAccountData` to return a structured result type including profile and organizations.
- Modified `getOrganizationsWithFilters` to specify a promise return type for better type safety.
- Added new type imports for organization-related data structures to improve clarity and maintainability.

These changes improve type safety and enhance the overall structure of the account and organization services.

* feat: implement Redis caching for presigned URLs and refactor API interactions

- Added Redis caching for presigned download URLs in the API to reduce redundant S3 calls, improving performance.
- Introduced a new `PresignApi` class in the frontend to centralize presigned URL requests, enhancing code maintainability.
- Updated various components to utilize the new `presignApi` methods for document and video upload/download operations.
- Enhanced error handling for Redis operations to ensure graceful degradation in case of cache failures.

These changes optimize the presigned URL generation process and streamline API interactions across the application.

* fix: add better-auth dependency to dashboard (#645)

* chore: unify exercise answer data format

* feat: make selfhosting run under one org for simplicity (#647)

* feat: implement self-hosting PRD + license key system

Self-hosting single-org:
- Add PUBLIC_IS_SELFHOSTED to API env, block org creation when org exists
- Auto-add non-members as students in GET /account bootstrap
- getOrgSiteInfo: root domain returns single org for self-hosted
- App init: route to /lms when self-hosted + no orgs
- Hide org switcher and Add Org modal when self-hosted

Invite-only signup:
- Add settings.signup.inviteOnly via ZUpdateOrganization
- Allow public signups toggle in org auth settings
- Signup page: hide form when invite-only and no invite context
- Landing page nav: respect inviteOnly for signup link

First signup auto-verify:
- Self-hosted first signup (no orgs) auto-verifies email in createProfileHook

License key system:
- LICENSE_KEY, LICENSE_VERIFICATION_URL for external verification API
- Feature gates: SSO, token-auth, no-tracking (PostHog/Senja)
- requireLicense middleware for API routes
- Dashboard: license store, gate PostHog/Senja/SSO/token-auth UI
- docs/LICENSE_API_CONTRACT.md for external API spec

Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>

* feat: get rid of carbon completely

* chore: license verification happens only for selfhosted instance

* fix: in self hosted instance, orgSite is the default

* docs: how to write math in cio editor

* Update packages/db/src/queries/organization/organization.ts

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

* Update apps/api/src/services/license.ts

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

* fix: translations, cursor pr reviews, simplify license fetching and check

* refactor: update analytics setup for cloud and self-hosted deployments; enhance settings merge logic

* refactor: update license fetching URL for development environment; optimize organization query to prevent plan row loss

* more selfhosting improvements

* feat: enhance signup guard for self-hosted instances by requiring organization context when no org ID is provided

* pr reviews

* fix: correct query parameter handling in course navigation

* pr reviews

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Rotimi Best <rotimi-best@users.noreply.github.com>
Co-authored-by: Abdulmuizz Hamzat <103611443+buildwithhamzat@users.noreply.github.com>
Co-authored-by: Adeyemi Adetunji <tvnji01@gmail.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
This commit is contained in:
Rotimi Best
2026-03-09 11:18:22 +01:00
committed by GitHub
co-authored by Rotimi Best greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Cursor Agent Abdulmuizz Hamzat Adeyemi Adetunji
parent a42565ad82
commit 1e9a82e912
1196 changed files with 118809 additions and 74705 deletions
@@ -0,0 +1 @@
export * from './submission';
@@ -0,0 +1,882 @@
import type { AnswerData, FileUploadAnswerData } from '@cio/question-types';
import { AppError, ErrorCodes } from '@api/utils/errors';
import type { TNewSubmission, TSubmission } from '@cio/db/types';
import type {
TSubmissionAnswerUpdate,
TSubmissionGradesUpdate,
TSubmissionUpdate
} from '@cio/utils/validation/submission';
import { buildEmailFromName, deliverEmail } from '@cio/email';
import {
createSubmission,
deleteSubmission,
getQuestionAnswersBySubmissionId,
getSubmissionById,
getSubmissionsByCourseIdWithDetails,
getSubmissionsForGrading,
updateQuestionAnswer,
updateSubmission,
updateSubmissionGrades,
upsertQuestionAnswer
} from '@cio/db/queries/submission';
import {
fromApiPayload,
getQuestionTypeById,
getQuestionTypeByTypename,
requiresManualGrading
} from '@cio/question-types';
import { getCourseById, getOrganizationByCourseId } from '@cio/db/queries/course';
import { getCourseTeachers, getProfileByGroupMemberId } from '@cio/db/queries/course/people';
import { getExerciseById, getExerciseWithRelationsOptimized } from '@cio/db/queries/exercise';
import { getGroupMemberIdByCourseAndProfile, isCourseTeamMemberOrOrgAdmin } from '@cio/db/queries/group';
import { QUESTION_TYPE_ID_TO_KEY } from '@cio/question-types';
import { db } from '@cio/db/drizzle';
import { env } from '@api/config/env';
import { generateDocumentDownloadPresignedUrls } from '@api/utils/s3';
type SubmissionGradingState = 'queued' | 'processing' | 'awaiting_manual' | 'completed' | 'failed';
type SubmissionOverallStatus = 'auto_graded' | 'manual_required' | 'hybrid';
const LEGACY_BOARD_STATUS_LABELS: Record<number, string> = {
1: 'Submitted',
2: 'In Progress',
3: 'Graded'
};
const LEGACY_STATUS_TO_GRADING_STATE: Record<number, SubmissionGradingState> = {
1: 'queued',
2: 'processing',
3: 'completed'
};
const GRADING_STATE_TO_LEGACY_STATUS: Record<SubmissionGradingState, number> = {
queued: 1,
processing: 2,
awaiting_manual: 2,
failed: 2,
completed: 3
};
const ALLOWED_GRADING_TRANSITIONS: Record<SubmissionGradingState, SubmissionGradingState[]> = {
queued: ['processing'],
processing: ['completed', 'awaiting_manual', 'failed'],
awaiting_manual: ['completed'],
failed: ['queued'],
completed: []
};
function projectLegacyStatusId(gradingState: SubmissionGradingState): number {
return GRADING_STATE_TO_LEGACY_STATUS[gradingState];
}
function resolveSubmissionGradingState(submission: Partial<TSubmission>): SubmissionGradingState {
const rawState = typeof submission.gradingState === 'string' ? submission.gradingState : '';
if (rawState && rawState in GRADING_STATE_TO_LEGACY_STATUS) {
return rawState as SubmissionGradingState;
}
const legacyStatusId = Number(submission.statusId ?? 1);
return LEGACY_STATUS_TO_GRADING_STATE[legacyStatusId] ?? 'queued';
}
function resolveOverallStatusFromTypenames(typenames: string[]): SubmissionOverallStatus {
const manualFlags = typenames.map((typename) => {
const metadata = getQuestionTypeByTypename(typename);
if (!metadata) return true;
return requiresManualGrading(metadata.key);
});
const hasManual = manualFlags.some(Boolean);
const hasAuto = manualFlags.some((value) => !value);
if (hasManual && hasAuto) return 'hybrid';
if (hasManual) return 'manual_required';
return 'auto_graded';
}
function resolveOverallStatusFromQuestionTypeIds(questionTypeIds: number[]): SubmissionOverallStatus {
const manualFlags = questionTypeIds.map((questionTypeId) => {
const metadata = getQuestionTypeById(questionTypeId);
if (!metadata) return true;
return requiresManualGrading(metadata.key);
});
const hasManual = manualFlags.some(Boolean);
const hasAuto = manualFlags.some((value) => !value);
if (hasManual && hasAuto) return 'hybrid';
if (hasManual) return 'manual_required';
return 'auto_graded';
}
function resolveRequestedGradingState(data: TSubmissionUpdate): SubmissionGradingState | null {
if (data.gradingState) {
return data.gradingState;
}
if (data.statusId === undefined) {
return null;
}
const mapped = LEGACY_STATUS_TO_GRADING_STATE[Number(data.statusId)];
if (!mapped) {
throw new AppError('Invalid submission status', ErrorCodes.VALIDATION_ERROR, 400);
}
return mapped;
}
function isAllowedGradingTransition(from: SubmissionGradingState, to: SubmissionGradingState): boolean {
if (from === to) return true;
return ALLOWED_GRADING_TRANSITIONS[from]?.includes(to) ?? false;
}
function isFileUpload(data: unknown): data is FileUploadAnswerData {
return !!data && typeof data === 'object' && (data as { type: string }).type === 'FILE_UPLOAD';
}
/**
* Enriches FILE_UPLOAD answers from DB rows (question_answer[]) with presigned download URLs.
* Used by getSubmission and listSubmissionsByExercise.
*/
async function enrichFileUploadAnswersArray<T extends { answerData?: unknown }>(answers: T[]): Promise<T[]> {
const fileKeys = answers
.map((a) => a.answerData)
.filter(isFileUpload)
.map((d) => d.fileKey);
if (fileKeys.length === 0) return answers;
try {
const urls = await generateDocumentDownloadPresignedUrls(fileKeys);
return answers.map((answer) => {
if (!isFileUpload(answer.answerData)) return answer;
const url = urls[answer.answerData.fileKey];
return url ? { ...answer, answerData: { ...answer.answerData, fileUrl: url } } : answer;
});
} catch (error) {
console.error('enrichFileUploadAnswersArray error:', error);
return answers;
}
}
/**
* Enriches FILE_UPLOAD entries in a { questionName → AnswerData } map with presigned download URLs.
* Used by getSubmissionsForGradingEmail to build the grading email payload.
*/
async function enrichFileUploadAnswersObject(answers: Record<string, AnswerData>): Promise<Record<string, AnswerData>> {
const fileKeys = Object.values(answers)
.filter(isFileUpload)
.map((d) => d.fileKey);
if (fileKeys.length === 0) return answers;
try {
const urls = await generateDocumentDownloadPresignedUrls(fileKeys);
return Object.fromEntries(
Object.entries(answers).map(([key, data]) => {
if (!isFileUpload(data)) return [key, data];
const url = urls[data.fileKey];
return url ? [key, { ...data, fileUrl: url }] : [key, data];
})
);
} catch (error) {
console.error('enrichFileUploadAnswersObject error:', error);
return answers;
}
}
/**
* Gets a submission by ID with question answers
* @param submissionId Submission ID
* @returns Submission with question answers
*/
export async function getSubmission(submissionId: string): Promise<TSubmission & { answers?: any[] }> {
try {
const submission = await getSubmissionById(submissionId);
if (!submission) {
throw new AppError('Submission not found', ErrorCodes.SUBMISSION_NOT_FOUND, 404);
}
let answers = await getQuestionAnswersBySubmissionId(submissionId);
if (answers.length > 0) {
answers = await enrichFileUploadAnswersArray(answers);
}
return {
...submission,
answers
};
} catch (error) {
if (error instanceof AppError) {
throw error;
}
throw new AppError(
error instanceof Error ? error.message : 'Failed to fetch submission',
ErrorCodes.SUBMISSION_FETCH_FAILED,
500
);
}
}
/** Submission with answers + groupmember (when listing by exercise). Used for route typing. */
type SubmissionWithDetails = Awaited<ReturnType<typeof getSubmissionsByCourseIdWithDetails>>[number];
/**
* Lists submissions for a course filtered by exercise (with answers, groupmember, enriched file URLs)
* @param courseId Course ID
* @param exerciseId Exercise ID (required)
* @param submittedBy Optional group member ID filter
*/
export async function listSubmissionsByExercise(
courseId: string,
exerciseId: string,
submittedBy?: string
): Promise<SubmissionWithDetails[]> {
try {
const submissions = await getSubmissionsByCourseIdWithDetails(courseId, exerciseId, submittedBy);
const enriched = await Promise.all(
submissions.map(async (s) =>
s.answers?.length ? { ...s, answers: await enrichFileUploadAnswersArray(s.answers) } : s
)
);
return enriched;
} catch (error) {
throw new AppError(
error instanceof Error ? error.message : 'Failed to list submissions by exercise',
ErrorCodes.INTERNAL_ERROR,
500
);
}
}
export type ExerciseSubmissionsOverview = {
mySubmission: Awaited<ReturnType<typeof listSubmissionsByExercise>>;
allSubmissions: Awaited<ReturnType<typeof listSubmissionsByExercise>>;
};
/**
* Returns submission overview for an exercise based on user role.
* - Students: mySubmission = their submission(s), allSubmissions = []
* - Instructors: mySubmission = [], allSubmissions = all submissions in exercise
*/
export async function listExerciseSubmissionsOverview(
courseId: string,
exerciseId: string,
profileId: string
): Promise<ExerciseSubmissionsOverview> {
try {
const [groupMemberId, isInstructor] = await Promise.all([
getGroupMemberIdByCourseAndProfile(courseId, profileId),
isCourseTeamMemberOrOrgAdmin(courseId, profileId)
]);
if (isInstructor) {
const allSubmissions = await listSubmissionsByExercise(courseId, exerciseId);
return { mySubmission: [], allSubmissions };
}
const mySubmission = groupMemberId ? await listSubmissionsByExercise(courseId, exerciseId, groupMemberId) : [];
return { mySubmission, allSubmissions: [] };
} catch (error) {
throw new AppError(
error instanceof Error ? error.message : 'Failed to list exercise submissions overview',
ErrorCodes.INTERNAL_ERROR,
500
);
}
}
/**
* Lists submissions for grading with pre-processed data
* @param courseId Course ID
* @returns Processed submissions organized by status sections
*/
export async function listSubmissionsForGrading(courseId: string) {
try {
const rawSubmissions = await getSubmissionsForGrading(courseId);
const course = await getCourseById(courseId);
type SubmissionItem = {
id: string;
statusId: number;
gradingState: SubmissionGradingState;
overallStatus: SubmissionOverallStatus;
isEarly: boolean;
feedback: string | null;
submittedAt: string;
exercise: {
id: string;
title: string;
};
answers: any[];
student: any | null;
lesson: {
id: string;
title: string;
} | null;
};
const sections: Array<{ id: number; title: string; value: number; items: SubmissionItem[] }> = [
{ id: 1, title: LEGACY_BOARD_STATUS_LABELS[1], value: 0, items: [] },
{ id: 2, title: LEGACY_BOARD_STATUS_LABELS[2], value: 0, items: [] },
{ id: 3, title: LEGACY_BOARD_STATUS_LABELS[3], value: 0, items: [] }
];
const submissionIdData: { [key: string]: any } = {};
// Process each submission
for (const submission of rawSubmissions) {
const gradingState = resolveSubmissionGradingState(submission);
const statusId = projectLegacyStatusId(gradingState);
const storedOverallStatus = typeof submission.overallStatus === 'string' ? submission.overallStatus : '';
const fallbackOverallStatus = resolveOverallStatusFromQuestionTypeIds(
(submission.exercise.questions || [])
.map((question: any) => Number(question.questionTypeId))
.filter((questionTypeId: number) => Number.isFinite(questionTypeId))
);
const overallStatus: SubmissionOverallStatus =
storedOverallStatus === 'auto_graded' ||
storedOverallStatus === 'manual_required' ||
storedOverallStatus === 'hybrid'
? (storedOverallStatus as SubmissionOverallStatus)
: fallbackOverallStatus;
const isEarly = submission.exercise.dueBy
? new Date(submission.createdAt!).getTime() <= new Date(submission.exercise.dueBy).getTime()
: true;
const submittedAt = new Intl.DateTimeFormat('en-US', {
dateStyle: 'full',
timeStyle: 'medium'
}).format(new Date(submission.createdAt!));
// Format answers
const questionByIdAndName: { [id: number]: string } = {};
const questionTypeById: { [id: number]: number } = {};
for (const question of submission.exercise.questions || []) {
questionByIdAndName[question.id] = question.name ?? '';
questionTypeById[question.id] = question.questionTypeId;
}
const formattedAnswers: { [questionName: string]: AnswerData } = {};
const questionAnswerByPoint: { [questionId: number]: number } = {};
for (const answer of submission.answers || []) {
const questionName = questionByIdAndName[answer.questionId];
if (
questionName &&
answer.answerData &&
typeof answer.answerData === 'object' &&
answer.answerData !== null &&
'type' in answer.answerData
) {
formattedAnswers[questionName] = answer.answerData as AnswerData;
}
questionAnswerByPoint[answer.questionId] = answer.point || 0;
}
const enrichedFormattedAnswers = await enrichFileUploadAnswersObject(formattedAnswers);
// Create submission item for sections
const submissionItem = {
id: submission.id,
statusId,
gradingState,
overallStatus,
isEarly,
feedback: submission.feedback,
submittedAt,
exercise: {
id: submission.exercise.id,
title: submission.exercise.title
},
answers: submission.answers || [],
student: submission.groupmember?.profile || null,
lesson: submission.lesson
? {
id: submission.lesson.id,
title: submission.lesson.title
}
: null
};
// Add to appropriate section
const sectionIndex = statusId - 1;
if (sectionIndex >= 0 && sectionIndex < sections.length) {
sections[sectionIndex].items.push(submissionItem);
sections[sectionIndex].value = sections[sectionIndex].items.length;
}
// Create detailed data for modal
submissionIdData[submission.id] = {
id: submission.id,
statusId,
gradingState,
overallStatus,
feedback: submission.feedback,
isEarly,
title: submission.exercise.title,
student: submission.groupmember?.profile || null,
questions: (submission.exercise.questions || []).map((q: any) => ({
id: q.id,
title: q.title,
name: q.name,
order: q.order,
points: q.points,
questionTypeId: q.questionTypeId,
settings: q.settings ?? {},
options: (q.options || []).map((opt: any) => ({
id: opt.id,
label: opt.label,
value: opt.value,
isCorrect: opt.isCorrect,
settings: opt.settings ?? {}
}))
})),
answers: enrichedFormattedAnswers,
questionAnswers: (submission.answers || []).map((answer: any) => ({
questionId: answer.questionId,
answerData: answer.answerData
})),
questionAnswerByPoint
};
}
return {
sections,
submissionIdData
};
} catch (error) {
throw new AppError(
error instanceof Error ? error.message : 'Failed to list submissions for grading',
ErrorCodes.INTERNAL_ERROR,
500
);
}
}
/**
* Creates a new submission with question answers
* @param courseId Course ID
* @param exerciseId Exercise ID
* @param submittedBy Group member ID
* @param answers Array of question answers
* @returns Created submission
*/
export async function createSubmissionService(
courseId: string,
exerciseId: string,
submittedBy: string,
answers: Array<{ questionId: number; optionId?: number; answer?: string }>
): Promise<TSubmission> {
try {
const exerciseWithRelations = await getExerciseWithRelationsOptimized(exerciseId);
const overallStatus = resolveOverallStatusFromTypenames(
exerciseWithRelations.questions
.map((question) => question.questionType?.typename ?? '')
.filter((typename) => typename.length > 0)
);
const gradingState: SubmissionGradingState = 'queued';
const submissionData: TNewSubmission = {
courseId,
exerciseId,
submittedBy,
statusId: projectLegacyStatusId(gradingState),
gradingState,
overallStatus,
total: 0 // Will be calculated during grading
};
const submission = await createSubmission(submissionData);
// Create question answers
if (answers.length > 0) {
const questionById = new Map(
exerciseWithRelations.questions.map((q) => {
const questionTypeKey = QUESTION_TYPE_ID_TO_KEY[q.questionTypeId] ?? 'TEXTAREA';
return [
q.id,
{
id: q.id,
title: q.title ?? '',
questionType: questionTypeKey,
options: (q.options ?? []).map((o) => ({
id: o.id,
label: o.label ?? '',
value: o.value ?? undefined,
isCorrect: o.isCorrect
}))
}
];
})
);
await db.transaction(async () => {
for (const ans of answers) {
const question = questionById.get(ans.questionId);
if (!question) continue;
const answerData = fromApiPayload(
question.questionType,
{ questionId: ans.questionId, optionId: ans.optionId, answer: ans.answer },
question
);
if (!answerData) continue;
await upsertQuestionAnswer({
submissionId: submission.id,
questionId: ans.questionId,
groupMemberId: submittedBy,
answerData
});
}
});
}
// Send email notification to teachers
try {
await sendExerciseSubmissionUpdateEmail(courseId, exerciseId, submittedBy);
} catch (emailError) {
// Log but don't fail the request if email fails
console.error('Failed to send exercise submission update email:', emailError);
}
return submission;
} catch (error) {
if (error instanceof AppError) {
throw error;
}
throw new AppError(
error instanceof Error ? error.message : 'Failed to create submission',
ErrorCodes.INTERNAL_ERROR,
500
);
}
}
/**
* Updates a submission
* @param submissionId Submission ID
* @param data Partial submission update data
* @returns Updated submission
*/
export async function updateSubmissionService(submissionId: string, data: TSubmissionUpdate): Promise<TSubmission> {
try {
const submission = await getSubmissionById(submissionId);
if (!submission) {
throw new AppError('Submission not found', ErrorCodes.SUBMISSION_NOT_FOUND, 404);
}
const currentGradingState = resolveSubmissionGradingState(submission);
const requestedGradingState = resolveRequestedGradingState(data);
if (requestedGradingState && !isAllowedGradingTransition(currentGradingState, requestedGradingState)) {
throw new AppError('Invalid submission workflow transition', ErrorCodes.VALIDATION_ERROR, 400);
}
const previousLegacyStatusId = projectLegacyStatusId(currentGradingState);
const updatePayload: Partial<TSubmission> = { ...data };
if (requestedGradingState) {
updatePayload.gradingState = requestedGradingState;
updatePayload.statusId = projectLegacyStatusId(requestedGradingState);
}
const nextLegacyStatusId = Number(updatePayload.statusId ?? previousLegacyStatusId);
const statusChanged = nextLegacyStatusId !== previousLegacyStatusId;
const updated = await updateSubmission(submissionId, updatePayload);
if (!updated) {
throw new AppError('Failed to update submission', ErrorCodes.INTERNAL_ERROR, 500);
}
// Send email notification if status changed
if (statusChanged) {
try {
await sendSubmissionUpdateEmail(submissionId, nextLegacyStatusId);
} catch (emailError) {
// Log but don't fail the request if email fails
console.error('Failed to send submission update email:', emailError);
}
}
return updated;
} catch (error) {
if (error instanceof AppError) {
throw error;
}
throw new AppError(
error instanceof Error ? error.message : 'Failed to update submission',
ErrorCodes.INTERNAL_ERROR,
500
);
}
}
/**
* Updates a question answer in a submission
* @param submissionId Submission ID
* @param questionId Question ID
* @param data Question answer update data
* @returns Updated question answer
*/
export async function updateSubmissionAnswer(
submissionId: string,
questionId: number,
data: TSubmissionAnswerUpdate
): Promise<any> {
try {
const submission = await getSubmissionById(submissionId);
if (!submission) {
throw new AppError('Submission not found', ErrorCodes.SUBMISSION_NOT_FOUND, 404);
}
const updateData: { point?: number } = {};
if (data.points !== undefined) updateData.point = data.points;
if (Object.keys(updateData).length === 0) return null;
const updated = await updateQuestionAnswer(submissionId, questionId, updateData);
if (!updated) {
throw new AppError('Question answer not found', ErrorCodes.INTERNAL_ERROR, 404);
}
return updated;
} catch (error) {
if (error instanceof AppError) {
throw error;
}
throw new AppError(
error instanceof Error ? error.message : 'Failed to update question answer',
ErrorCodes.INTERNAL_ERROR,
500
);
}
}
/**
* Updates all question answer points and submission total/feedback in a single transaction.
* Submitting grades automatically transitions status to Graded (statusId 3, gradingState completed).
*/
export async function updateSubmissionGradesBatch(
submissionId: string,
data: TSubmissionGradesUpdate
): Promise<TSubmission> {
try {
const submission = await getSubmissionById(submissionId);
if (!submission) {
throw new AppError('Submission not found', ErrorCodes.SUBMISSION_NOT_FOUND, 404);
}
const currentGradingState = resolveSubmissionGradingState(submission);
const targetGradingState: SubmissionGradingState = 'completed';
const targetStatusId = projectLegacyStatusId(targetGradingState);
if (!isAllowedGradingTransition(currentGradingState, targetGradingState)) {
throw new AppError('Invalid submission workflow transition', ErrorCodes.VALIDATION_ERROR, 400);
}
const previousLegacyStatusId = projectLegacyStatusId(currentGradingState);
const statusChanged = targetStatusId !== previousLegacyStatusId;
const updated = await updateSubmissionGrades(submissionId, {
answers: data.answers,
total: data.total,
feedback: data.feedback,
statusId: targetStatusId,
gradingState: targetGradingState
});
if (!updated) {
throw new AppError('Failed to update grades', ErrorCodes.INTERNAL_ERROR, 500);
}
if (statusChanged) {
try {
await sendSubmissionUpdateEmail(submissionId, targetStatusId);
} catch (emailError) {
console.error('Failed to send submission update email:', emailError);
}
}
return updated;
} catch (error) {
if (error instanceof AppError) {
throw error;
}
throw new AppError(
error instanceof Error ? error.message : 'Failed to update submission grades',
ErrorCodes.INTERNAL_ERROR,
500
);
}
}
/**
* Deletes a submission
* @param submissionId Submission ID
* @returns Deleted submission
*/
export async function deleteSubmissionService(submissionId: string): Promise<TSubmission> {
try {
const submission = await getSubmissionById(submissionId);
if (!submission) {
throw new AppError('Submission not found', ErrorCodes.SUBMISSION_NOT_FOUND, 404);
}
const deleted = await deleteSubmission(submissionId);
if (!deleted) {
throw new AppError('Failed to delete submission', ErrorCodes.INTERNAL_ERROR, 500);
}
return deleted;
} catch (error) {
if (error instanceof AppError) {
throw error;
}
throw new AppError(
error instanceof Error ? error.message : 'Failed to delete submission',
ErrorCodes.INTERNAL_ERROR,
500
);
}
}
/**
* Sends email notification to student when submission status changes
*/
async function sendSubmissionUpdateEmail(submissionId: string, newStatusId: number) {
const submission = await getSubmissionById(submissionId);
if (!submission || !submission.courseId) {
return;
}
const submissionData = await getSubmissionsForGrading(submission.courseId);
const fullSubmission = submissionData.find((s) => s.id === submissionId);
if (!fullSubmission || !fullSubmission.groupmember?.profile?.email) {
return;
}
const courseResult = await getCourseById(fullSubmission.courseId || '');
const course = courseResult[0];
if (!course) {
return;
}
// Get organization name
const orgResult = await getOrganizationByCourseId(fullSubmission.courseId || '');
const orgName = orgResult?.orgName || 'ClassroomIO';
const statusText = LEGACY_BOARD_STATUS_LABELS[newStatusId] || 'Updated';
const baseUrl = env.NODE_ENV === 'development' ? 'http://localhost:5173' : 'https://app.classroomio.com';
const exerciseLink = `${baseUrl}/courses/${fullSubmission.courseId}/exercises/${fullSubmission.exercise.id}`;
// Calculate total and max points
const answers = fullSubmission.answers || [];
const totalMark = answers.reduce((sum: number, a: any) => sum + (a.point || 0), 0);
const maxMark = (fullSubmission.exercise.questions || []).reduce((sum: number, q: any) => sum + (q.points || 0), 0);
let content = `
<p>Hello ${fullSubmission.groupmember.profile.fullname || 'Student'},</p>
<p>The status of your submitted exercise on <strong>${fullSubmission.exercise.title}</strong> has been updated to ${statusText}</p>
`;
if (newStatusId === 3) {
content += `
<p>Your score was ${totalMark}/${maxMark}</p>
<a class="button" href="${exerciseLink}">View your Result</a>
`;
} else {
content += `<a class="button" href="${exerciseLink}">Open Exercise</a>`;
}
if (fullSubmission.lesson?.title) {
content += `
<p>This exercise is for <strong>${fullSubmission.lesson.title}</strong> in a course you are taking titled <strong>${course.title}</strong></p>
`;
} else {
content += `
<p>This exercise is in a course you are taking titled <strong>${course.title}</strong></p>
`;
}
await deliverEmail([
{
from: buildEmailFromName(`${orgName} (via ClassroomIO.com)`),
to: fullSubmission.groupmember.profile.email,
subject: 'Submission Update',
content
}
]);
}
/**
* Sends email notification to teachers when a student submits an exercise
*/
async function sendExerciseSubmissionUpdateEmail(courseId: string, exerciseId: string, submittedBy: string) {
// Get course and exercise data
const course = await getCourseById(courseId);
if (!course) {
return;
}
const exercise = await getExerciseById(exerciseId);
if (!exercise) {
return;
}
// Get student info
const student = await getProfileByGroupMemberId(submittedBy);
if (!student) {
return;
}
// Get tutors (ADMIN or TUTOR role) from the course's group
const tutorsResult = await getCourseTeachers({ courseId });
if (tutorsResult.length === 0) {
return;
}
// Get organization name
const orgResult = await getOrganizationByCourseId(courseId);
const orgName = orgResult?.orgName || 'ClassroomIO';
const baseUrl = env.NODE_ENV === 'development' ? 'http://localhost:5173' : 'https://app.classroomio.com';
const exerciseLink = `${baseUrl}/courses/${courseId}/exercises/${exerciseId}`;
const submissionLink = `${baseUrl}/courses/${courseId}/submissions`;
const content = `
<p>Hello,</p>
<p>A student ${student.fullname || student.username} just submitted an exercise <a href="${exerciseLink}">${exercise.title}</a></p>
<p>You can get started grading by clicking "Open Submissions"</p>
<div>
<a class="button" href="${submissionLink}">Open Submissions</a>
</div>
`;
// Send email to all tutors
const emailPromises = tutorsResult.map((tutor) => {
if (!tutor.email) return Promise.resolve();
return deliverEmail([
{
from: buildEmailFromName(`${orgName} (via ClassroomIO.com)`),
to: tutor.email,
subject: `[Submitted]: ${exercise.title}`,
content
}
]);
});
await Promise.all(emailPromises);
}