Files
encoach_frontend_v4/src/hooks/queries/useCourseware.ts
Yamen Ahmad 435930a827 feat: institutional + support + training admin sections (backend + frontend)
Ship three fully-wired admin areas end-to-end with APIs, seeds, tests and docs.

Backend (new `encoach_lms_api` addon + existing addons):
- Institutional: academic years/terms, departments, admission registers & admissions,
  courses/batches, lessons, fees (terms + student fees + invoicing with income-account
  auto-wiring), gradebook (assignments/grades), library, facilities (encoach.asset),
  student leave, result templates + marksheets (incl. delete-with-cascade).
- Support: `encoach.ticket` model + CRUD/assignee routes; payment records derived
  from `op.student.fees.details` and `account.move`; platform settings backed by
  `encoach.code` and `ir.config_parameter` (packages + grading config).
- Training: `encoach.vocab.item` + `encoach.grammar.rule` (plus progress models)
  with CRUD, pagination, search/level filters, and upsert-style progress endpoints.
  Odoo 19 compatibility: `_sql_constraints` replaced with `@api.constrains`;
  `ValidationError`/`UserError` mapped to HTTP 400.

Frontend:
- Rewire institutional admin pages (Academic Year Manager, Admissions, Courses,
  Lessons, Fees, Gradebook, Library, Facilities, Student Leave, Marksheets,
  Taxonomy, Resources) to real APIs with React Query invalidation and dialogs.
- New typed services: `payments.service.ts`, `platformSettings.service.ts`,
  `training.service.ts`. Updated `fees/gradebook/lms/courseware/taxonomy/
  resources/student-progress/generation` services + related types.
- Rewrite `VocabularyPage`, `GrammarPage`, `PaymentRecordPage`, `SettingsPage`,
  `TicketsPage` to consume live data with search/filter/progress/CRUD flows.
- New shared components: `TaxonomyCascade`, `MaterialViewer`, `teacher/TeacherLibrary`.
- Favicons/branding assets and misc. UX polish across teacher/student pages.

Tooling & QA:
- Seeders: `seed_demo.py`, `seed_demo_data.py`, `seed_institutional.py` (idempotent,
  covers institutional + support + training fixtures incl. income-account wiring).
- API write-flow test suites: `test_write_flows.py` (institutional),
  `test_support_flows.py` (support), `test_training_flows.py` (training),
  `test_ai_full.py`. All suites pass end-to-end.
- Docs: add `docs/PROJECT_SUMMARY.md` with per-section scope, artifacts and QA.
- `.gitignore`: ignore `pgdata_bak_*/`, `frontend/.vite/`, `frontend/dist/`,
  `frontend/node_modules/`.

Made-with: Cursor
2026-04-19 03:13:23 +04:00

229 lines
7.7 KiB
TypeScript

import { useQuery, useMutation, useQueryClient } from "@tanstack/react-query";
import { queryKeys } from "./keys";
import { coursewareService } from "@/services/courseware.service";
import type {
ChapterCreateRequest,
WorkbenchGenerateRequest,
} from "@/types/courseware";
export function useChapters(courseId: number) {
return useQuery({
queryKey: queryKeys.chapters(courseId),
queryFn: () => coursewareService.listChapters(courseId),
enabled: !!courseId,
});
}
export function useChapter(id: number) {
return useQuery({
queryKey: queryKeys.chapter(id),
queryFn: () => coursewareService.getChapter(id),
enabled: !!id,
});
}
export function useChapterMaterials(chapterId: number) {
return useQuery({
queryKey: queryKeys.chapterMaterials(chapterId),
queryFn: () => coursewareService.listMaterials(chapterId),
enabled: !!chapterId,
});
}
export function useChapterProgress(chapterId: number) {
return useQuery({
queryKey: queryKeys.chapterProgress(chapterId),
queryFn: () => coursewareService.getChapterProgress(chapterId),
enabled: !!chapterId,
});
}
export function useCreateChapter() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ courseId, data }: { courseId: number; data: ChapterCreateRequest }) =>
coursewareService.createChapter(courseId, data),
onSuccess: (_, { courseId }) => {
qc.invalidateQueries({ queryKey: queryKeys.chapters(courseId) });
},
});
}
export function useUpdateChapter() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ id, data }: { id: number; data: Partial<ChapterCreateRequest> }) =>
coursewareService.updateChapter(id, data),
onSuccess: (chapter) => {
qc.invalidateQueries({ queryKey: queryKeys.chapter(chapter.id) });
qc.invalidateQueries({ queryKey: queryKeys.chapters(chapter.course_id) });
},
});
}
export function useDeleteChapter() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ id, courseId }: { id: number; courseId: number }) =>
coursewareService.deleteChapter(id),
onSuccess: (_, { courseId }) => {
qc.invalidateQueries({ queryKey: queryKeys.chapters(courseId) });
},
});
}
export function useUnlockChapter() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ id, courseId }: { id: number; courseId: number }) =>
coursewareService.unlockChapter(id),
onSuccess: (_, { id, courseId }) => {
qc.invalidateQueries({ queryKey: queryKeys.chapter(id) });
qc.invalidateQueries({ queryKey: queryKeys.chapters(courseId) });
},
});
}
export function useLockChapter() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ id, courseId }: { id: number; courseId: number }) =>
coursewareService.lockChapter(id),
onSuccess: (_, { id, courseId }) => {
qc.invalidateQueries({ queryKey: queryKeys.chapter(id) });
qc.invalidateQueries({ queryKey: queryKeys.chapters(courseId) });
},
});
}
export function useReorderChapters() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ courseId, body }: { courseId: number; body: { ids: number[] } }) =>
coursewareService.reorderChapters(courseId, body),
onSuccess: (_, { courseId }) => {
qc.invalidateQueries({ queryKey: queryKeys.chapters(courseId) });
},
});
}
export function useUploadMaterial() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ chapterId, formData }: { chapterId: number; formData: FormData }) =>
coursewareService.uploadMaterial(chapterId, formData),
onSuccess: (_, { chapterId }) => {
qc.invalidateQueries({ queryKey: queryKeys.chapterMaterials(chapterId) });
qc.invalidateQueries({ queryKey: queryKeys.chapterProgress(chapterId) });
qc.invalidateQueries({ queryKey: queryKeys.chapter(chapterId) });
},
});
}
export function useCreateMaterialFromResource() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ chapterId, resourceId, name }: { chapterId: number; resourceId: number; name?: string }) =>
coursewareService.createMaterialFromResource(chapterId, resourceId, name),
onSuccess: (_, { chapterId }) => {
qc.invalidateQueries({ queryKey: queryKeys.chapterMaterials(chapterId) });
qc.invalidateQueries({ queryKey: queryKeys.chapterProgress(chapterId) });
qc.invalidateQueries({ queryKey: queryKeys.chapter(chapterId) });
},
});
}
export function useDeleteMaterial() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ id, chapterId }: { id: number; chapterId: number }) =>
coursewareService.deleteMaterial(id),
onSuccess: (_, { chapterId }) => {
qc.invalidateQueries({ queryKey: queryKeys.chapterMaterials(chapterId) });
qc.invalidateQueries({ queryKey: queryKeys.chapterProgress(chapterId) });
qc.invalidateQueries({ queryKey: queryKeys.chapter(chapterId) });
},
});
}
export function useMarkMaterialViewed() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ id, chapterId }: { id: number; chapterId: number }) =>
coursewareService.markMaterialViewed(id),
onSuccess: (_, { chapterId }) => {
qc.invalidateQueries({ queryKey: queryKeys.chapterMaterials(chapterId) });
qc.invalidateQueries({ queryKey: queryKeys.chapterProgress(chapterId) });
},
});
}
export function useCourseCompletion(courseId: number) {
return useQuery({
queryKey: queryKeys.courseCompletion(courseId),
queryFn: () => coursewareService.getCourseCompletion(courseId),
enabled: !!courseId,
});
}
export function useCompleteChapter() {
const qc = useQueryClient();
return useMutation({
mutationFn: ({ chapterId, courseId }: { chapterId: number; courseId: number }) =>
coursewareService.markChapterComplete(chapterId),
onSuccess: (_, { chapterId, courseId }) => {
qc.invalidateQueries({ queryKey: queryKeys.chapterProgress(chapterId) });
qc.invalidateQueries({ queryKey: queryKeys.chapter(chapterId) });
qc.invalidateQueries({ queryKey: queryKeys.courseCompletion(courseId) });
qc.invalidateQueries({ queryKey: queryKeys.lms.myCourses });
},
});
}
export function useGenerateOutline() {
const qc = useQueryClient();
return useMutation({
mutationFn: (data: WorkbenchGenerateRequest) => coursewareService.generateOutline(data),
onSuccess: (_, data) => {
qc.invalidateQueries({ queryKey: queryKeys.chapters(data.course_id) });
qc.invalidateQueries({ queryKey: queryKeys.lms.course(data.course_id) });
},
});
}
export function useGenerateChapterContent() {
const qc = useQueryClient();
return useMutation({
mutationFn: (data: WorkbenchGenerateRequest) => coursewareService.generateChapterContent(data),
onSuccess: (_, data) => {
qc.invalidateQueries({ queryKey: queryKeys.chapters(data.course_id) });
qc.invalidateQueries({ queryKey: queryKeys.lms.course(data.course_id) });
},
});
}
export function useGenerateRubric() {
const qc = useQueryClient();
return useMutation({
mutationFn: (data: WorkbenchGenerateRequest) => coursewareService.generateRubric(data),
onSuccess: (_, data) => {
qc.invalidateQueries({ queryKey: queryKeys.chapters(data.course_id) });
qc.invalidateQueries({ queryKey: queryKeys.lms.course(data.course_id) });
},
});
}
export function usePublishWorkbench() {
const qc = useQueryClient();
return useMutation({
mutationFn: (data: Record<string, unknown>) => coursewareService.publishWorkbench(data),
onSuccess: (_, data) => {
const courseId = data.course_id;
if (typeof courseId === "number") {
qc.invalidateQueries({ queryKey: queryKeys.chapters(courseId) });
qc.invalidateQueries({ queryKey: queryKeys.lms.course(courseId) });
}
},
});
}