ulivargas/classroomio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: certificates, landing pages, ai tutor, website update, compliance

Browse Source
This commit is contained in:
Rotimi Best
2026-05-18 03:47:22 +01:00
parent c31ad63955
commit ac3a2c14a7
644 changed files with 56050 additions and 5439 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/ai-assistant/src/tools/index.ts
+26 -5
View File
@@ -16,8 +16,17 @@ import {
updateCourseLandingPageSchema,
checkCourseGoLiveReadinessSchema,
goLiveCourseSchema,
generateCoursePlanSchema
generateCoursePlanSchema,
askTemplateQuestionsSchema,
fetchDocumentationUrlSchema
} from './teacher';
import { listCourseOutlineSchema, readLessonSchema, readExerciseSchema, searchCourseSchema } from './student';
export {
LANDING_PAGE_COURSE_DESCRIPTION_PLAIN_HINT,
LANDING_PAGE_METADATA_DESCRIPTION_SECTION_HINT,
LANDING_PAGE_SECTION_HTML_AGENT_HINT
} from './landing-page-html-hint';
export type ToolSchema = {
description: string;
@@ -47,11 +56,17 @@ const teacherTools: ToolRegistry = {
[ToolName.UPDATE_COURSE_LANDING_PAGE]: updateCourseLandingPageSchema,
[ToolName.CHECK_COURSE_GO_LIVE_READINESS]: checkCourseGoLiveReadinessSchema,
[ToolName.GO_LIVE_COURSE]: goLiveCourseSchema,
[ToolName.GENERATE_COURSE_PLAN]: generateCoursePlanSchema
[ToolName.GENERATE_COURSE_PLAN]: generateCoursePlanSchema,
[ToolName.ASK_TEMPLATE_QUESTIONS]: askTemplateQuestionsSchema,
[ToolName.FETCH_DOCUMENTATION_URL]: fetchDocumentationUrlSchema
};
// v2: student tools will be added here
const studentTools: ToolRegistry = {};
const studentTools: ToolRegistry = {
[ToolName.LIST_COURSE_OUTLINE]: listCourseOutlineSchema,
[ToolName.READ_LESSON]: readLessonSchema,
[ToolName.READ_EXERCISE]: readExerciseSchema,
[ToolName.SEARCH_COURSE]: searchCourseSchema
};
/**
* Returns tool schemas available for a given role.
@@ -88,5 +103,11 @@ export {
updateCourseLandingPageSchema,
checkCourseGoLiveReadinessSchema,
goLiveCourseSchema,
generateCoursePlanSchema
generateCoursePlanSchema,
askTemplateQuestionsSchema,
fetchDocumentationUrlSchema,
listCourseOutlineSchema,
readLessonSchema,
readExerciseSchema,
searchCourseSchema
};
packages/ai-assistant/src/tools/landing-page-html-hint.ts
+18
View File
@@ -0,0 +1,18 @@
const LANDING_PAGE_HTML_FORMATTING_RULES =
'Use <p>, <strong> or <b>, <em> or <i>, lists, and <br> as needed. Do not use heading tags (<h1> through <h6>)—the layout already shows each section title. Use normal paragraph text with bold and italic emphasis only.';
/**
* Schema / tool-call guidance for HTML landing-page sections (overview, goals, requirements, etc.).
*/
export const LANDING_PAGE_SECTION_HTML_AGENT_HINT = `HTML only. ${LANDING_PAGE_HTML_FORMATTING_RULES}`;
/**
* Top-level course `description` — the short public course description (not `metadata.description`).
*/
export const LANDING_PAGE_COURSE_DESCRIPTION_PLAIN_HINT =
'Plain text only, no HTML—the short public course description.';
/**
* `metadata.description` — the Description block shown after Requirements on the landing page.
*/
export const LANDING_PAGE_METADATA_DESCRIPTION_SECTION_HINT = `HTML for the Description section that appears after Requirements on the landing page (not the top-level course description field). ${LANDING_PAGE_HTML_FORMATTING_RULES}`;
packages/ai-assistant/src/tools/student.ts
+42 -4
View File
@@ -1,7 +1,45 @@
import { z } from 'zod';
/**
* Student tool schemas (v2 stubs).
* These will be implemented in Phase 5 when student assistant is enabled.
* For now, this file exists to establish the pattern and keep the registry clean.
* Student tool schemas — read-only, course-scoped.
*
* The student agent uses these to ground answers in this course's content.
* Every server-side implementation MUST verify the lesson/exercise belongs to
* the current course and never reveal answer keys or solutions.
*/
// v2: explain_concept, quiz_me, clarify_exercise, get_my_progress, get_my_submissions
export const listCourseOutlineSchema = {
description:
'List the current course outline: sections with their lessons and exercises (titles + ids only, no content). Use this first to understand what is available before reading a specific lesson or exercise.',
parameters: z.object({
courseId: z.string().describe('The current course ID. Must match the active course context.')
})
};
export const readLessonSchema = {
description:
'Read the rendered text of a lesson in the current course. Use this when the learner refers to a lesson that is not currently open, or when answering a question requires content from a specific lesson. Returns lesson title plus body text (no answer keys).',
parameters: z.object({
courseId: z.string().describe('The current course ID'),
lessonId: z.string().describe('The lesson ID. Must belong to this course.')
})
};
export const readExerciseSchema = {
description:
'Read an exercise prompt — the question text and instructions visible to a student. NEVER returns correct answers, marking schemes, or solutions. Use this to understand what the learner is being asked.',
parameters: z.object({
courseId: z.string().describe('The current course ID'),
exerciseId: z.string().describe('The exercise ID. Must belong to this course.')
})
};
export const searchCourseSchema = {
description:
'Search this course for lessons and exercises whose title or body matches a free-text query. Returns ranked snippets with lesson or exercise ids so you can follow up with read_lesson / read_exercise. Use this when the learner asks "where did we cover X?" or refers to material by topic instead of by title.',
parameters: z.object({
courseId: z.string().describe('The current course ID'),
query: z.string().min(1).max(200).describe('Free-text query — keywords or a short phrase.'),
limit: z.number().int().min(1).max(20).default(8).describe('Maximum number of results to return.')
})
};
packages/ai-assistant/src/tools/teacher.ts
+41 -14
View File
@@ -1,6 +1,12 @@
import { z } from 'zod';
import { QUESTION_TYPE_REGISTRY } from '@cio/question-types';
import { CoursePlanSchema } from '../types';
import { CourseTemplateIdSchema, TemplateFormFieldSchema } from '../templates';
import {
LANDING_PAGE_COURSE_DESCRIPTION_PLAIN_HINT,
LANDING_PAGE_METADATA_DESCRIPTION_SECTION_HINT,
LANDING_PAGE_SECTION_HTML_AGENT_HINT
} from './landing-page-html-hint';
const QUESTION_TYPE_ID_DESCRIPTION = QUESTION_TYPE_REGISTRY.map((t) => `${t.id}=${t.typename} (${t.label})`).join(', ');
@@ -127,8 +133,9 @@ export const createExerciseSchema = {
.int()
.min(1)
.max(QUESTION_TYPE_REGISTRY.length)
.default(1)
.describe(`Question type ID. Supported types: ${QUESTION_TYPE_ID_DESCRIPTION}`),
.describe(
`Required on every question — never omit. Supported types: ${QUESTION_TYPE_ID_DESCRIPTION}. Vary types across questions (do not default everything to RADIO/1).`
),
points: z.number().min(0).default(1).describe('Points for this question'),
order: z.number().int().min(0).describe('Display order'),
options: z
@@ -239,8 +246,9 @@ export const addQuestionsSchema = {
.int()
.min(1)
.max(QUESTION_TYPE_REGISTRY.length)
.default(1)
.describe(`Question type ID. Supported types: ${QUESTION_TYPE_ID_DESCRIPTION}`),
.describe(
`Required on every question — never omit. Supported types: ${QUESTION_TYPE_ID_DESCRIPTION}. Vary types across questions (do not default everything to RADIO/1).`
),
points: z.number().min(0).default(1).describe('Points for this question'),
order: z.number().int().min(0).describe('Display order'),
options: z.array(
@@ -308,12 +316,12 @@ export const updateQuestionsSchema = {
export const updateCourseLandingPageSchema = {
description:
'Update public course landing-page fields, including title, description, overview, goals, requirements, instructor details, pricing, and banner image.',
'Update public course landing-page fields. The top-level course description is plain text (no HTML). The metadata description field is the Description block after Requirements and must be HTML, along with overview, goals, requirements, and instructor bio—paragraphs and bold/italic only, never h1–h6. Title is plain text.',
parameters: z.object({
courseId: z.string().describe('The course ID'),
title: z.string().min(1).optional().describe('Public course title'),
description: z.string().min(1).optional().describe('Short public course description'),
overview: z.string().optional().describe('Landing-page overview copy'),
title: z.string().min(1).optional().describe('Plain-text public course title (no HTML)'),
description: z.string().min(1).optional().describe(LANDING_PAGE_COURSE_DESCRIPTION_PLAIN_HINT),
overview: z.string().optional().describe(LANDING_PAGE_SECTION_HTML_AGENT_HINT),
cost: z.number().int().min(0).optional().describe('Course price in the selected currency'),
currency: z.enum(['NGN', 'USD']).optional().describe('Course price currency'),
imageUrl: z.string().url().optional().describe('Banner image URL to use directly'),
@@ -321,9 +329,9 @@ export const updateCourseLandingPageSchema = {
imageQuery: z.string().min(1).max(120).optional().describe('Search query for a generated/selected banner image'),
metadata: z
.object({
requirements: z.string().optional(),
description: z.string().optional(),
goals: z.string().optional(),
requirements: z.string().optional().describe(LANDING_PAGE_SECTION_HTML_AGENT_HINT),
description: z.string().optional().describe(LANDING_PAGE_METADATA_DESCRIPTION_SECTION_HINT),
goals: z.string().optional().describe(LANDING_PAGE_SECTION_HTML_AGENT_HINT),
videoUrl: z.string().optional(),
showDiscount: z.boolean().optional(),
discount: z.number().optional(),
@@ -333,7 +341,7 @@ export const updateCourseLandingPageSchema = {
name: z.string().optional(),
role: z.string().optional(),
coursesNo: z.number().optional(),
description: z.string().optional(),
description: z.string().optional().describe(LANDING_PAGE_SECTION_HTML_AGENT_HINT),
imgUrl: z.string().optional()
})
.optional()
@@ -362,10 +370,29 @@ export const goLiveCourseSchema = {
export const generateCoursePlanSchema = {
description:
'Generate a structured course plan with sections and lessons based on a topic or uploaded document. Returns a JSON plan that the teacher can review and approve before any content is created. Always use this tool when the teacher asks you to design, structure, or plan a course.',
'Generate a structured course plan with sections and lessons based on a topic or uploaded document. Returns a JSON plan that the teacher can review and approve before any content is created. Always use this tool when the teacher asks you to design, structure, or plan a course. The LAST section MUST be the comprehensive final examination (see plan schema): at least one exercise item that will cover every prior course section with multiple in-exercise question blocks and 3–5 questions per prior section.',
parameters: z.object({
plan: CoursePlanSchema.describe(
'The proposed course structure with sections and lessons. Each lesson includes a short description and whether it should have an exercise.'
'The proposed course structure. Instructional content lives in prior sections; the final section is always the course final examination (see schema). Each lesson includes a short description and whether it should have a linked exercise.'
)
})
};
export const askTemplateQuestionsSchema = {
description:
'Render a structured questionnaire card to the teacher for a template flow. Pause until the teacher submits answers via a user message with metadata.template.action="submit_template_answers" or skips via metadata.template.action="skip_template_form".',
parameters: z.object({
templateId: CourseTemplateIdSchema,
title: z.string().min(1),
description: z.string().optional(),
fields: z.array(TemplateFormFieldSchema).min(1)
})
};
export const fetchDocumentationUrlSchema = {
description:
'Fetch a public documentation URL via Jina Reader and return cleaned markdown plus a list of same-origin sub-page links. Use this iteratively when the teacher provided a documentation URL: start with the root, then call again with the most relevant 5–15 sub-pages until you have enough product context.',
parameters: z.object({
url: z.string().url()
})
};