feat: enhance API and middleware functionality: add public API routes, implement program and course member checks, and improve rate limiting for invite acceptance. Update OpenAPI spec generation to focus on public API endpoints and add new middleware for automation key scopes. Include new documentation for lesson AI features and public API tests.

This commit is contained in:
Rotimi Best
2026-04-12 08:58:41 +01:00
parent 5a8f50f67b
commit d6e812d08b
573 changed files with 31964 additions and 8708 deletions
@@ -1,6 +1,6 @@
import type { LMSExercise } from './exercises.svelte';
import type { GetLMSExercisesSuccess, LMSExercise } from './exercises.svelte';
import { classroomio } from '$lib/utils/services/api';
import { getApiKeyHeaders } from '$lib/utils/services/api/server';
import { getApiKeyHeaders, safeServerApi } from '$lib/utils/services/api/server';
/**
* Server-side API methods for LMS exercises
@@ -15,15 +15,15 @@ export class LMSExercisesApiServer {
*/
static async fetchLMSExercises(orgId: string): Promise<LMSExercise[] | null> {
try {
const response = await classroomio.organization[':orgId'].exercises.lms.$get(
{
param: { orgId }
},
getApiKeyHeaders()
const result = await safeServerApi<GetLMSExercisesSuccess>(() =>
classroomio.organization[':orgId'].exercises.lms.$get(
{
param: { orgId }
},
getApiKeyHeaders()
)
);
const data = await response.json();
return data.success && data.data ? data.data : null;
return result.ok && result.body.data ? result.body.data : null;
} catch (error) {
console.error('Error fetching LMS exercises (server):', error);
return null;
@@ -0,0 +1,90 @@
<script lang="ts">
import { Button } from '@cio/ui/base/button';
import * as Dialog from '@cio/ui/base/dialog';
import { classroomio } from '$lib/utils/services/api';
import { snackbar } from '$features/ui/snackbar/store';
import { t } from '$lib/utils/functions/translations';
import { ROLE } from '@cio/utils/constants';
import type { PendingOrgInvite } from '../utils/types';
interface Props {
open?: boolean;
invite: PendingOrgInvite;
onAccepted?: () => void;
}
let { open = $bindable(false), invite, onAccepted }: Props = $props();
let isLoading = $state(false);
const orgName = $derived(invite.organization.name);
function getInvitationMessage(): string {
if (invite.roleId === ROLE.STUDENT) {
return t.get('invite.organization.invitation_student', { orgName });
}
if (invite.roleId === ROLE.TUTOR) {
return t.get('invite.organization.invitation_teacher', { orgName });
}
if (invite.roleId === ROLE.ADMIN) {
return t.get('invite.organization.invitation_admin', { orgName });
}
return t.get('invite.organization.invitation_fallback', { orgName, role: invite.roleLabel });
}
async function handleAccept() {
isLoading = true;
try {
const response = await classroomio.invite.organization[':inviteId']['accept-by-id'].$post({
param: { inviteId: invite.id }
});
const result = await response.json();
if (!result.success) {
const failed = result as { error?: string; message?: string };
snackbar.error(failed.error ?? failed.message ?? t.get('invite.organization.messages.join_failed'));
return;
}
snackbar.success('invite.organization.messages.joined');
open = false;
onAccepted?.();
} catch (error) {
console.error('Failed to accept organization invite by id', error);
snackbar.error('invite.organization.messages.join_failed');
} finally {
isLoading = false;
}
}
</script>
<Dialog.Root
bind:open
onOpenChange={(isOpen) => {
if (!isOpen && !isLoading) open = false;
}}
>
<Dialog.Content class="w-96 p-6">
<Dialog.Header class="p-2">
<Dialog.Title>{$t('invite.organization.page_title', { orgName })}</Dialog.Title>
</Dialog.Header>
<div class="mt-2 space-y-3 px-2 text-center">
<p class="text-sm font-light dark:text-white">{getInvitationMessage()}</p>
<p class="text-sm font-light dark:text-white">{$t('invite.organization.email_line', { email: invite.email })}</p>
</div>
<div class="mt-6 flex items-center justify-between">
<Button variant="outline" onclick={() => (open = false)} disabled={isLoading}>
{$t('delete_modal.no')}
</Button>
<Button onclick={handleAccept} loading={isLoading} disabled={isLoading}>
{$t('invite.organization.accept_button')}
</Button>
</div>
</Dialog.Content>
</Dialog.Root>
@@ -7,6 +7,7 @@
import { profile } from '$lib/utils/store/user';
import { coursesApi } from '$features/course/api';
import { resolve } from '$app/paths';
import { BlurFade } from '@cio/ui/custom/animation/blurfade';
let totalCompleted = $derived(
coursesApi.enrolledCourses.reduce((acc, cur) => {
@@ -32,30 +33,34 @@
});
</script>
<div class="flex h-fit w-full flex-col-reverse justify-between rounded-md border px-4 py-2 md:flex-row md:items-center">
<div class="w-full md:w-[75%] lg:w-[80%]">
<p class="mb-5 w-4/6 font-normal lg:text-xl">
{$currentOrg.customization.dashboard.bannerText
? $currentOrg.customization.dashboard.bannerText
: $t('dashboard.lms_dashboard_hero')}
</p>
<Button onclick={() => goto(resolve('/lms/mylearning', {}))}>
{$t('dashboard.continue_learning')}
</Button>
<BlurFade delay={0} once>
<div
class="flex h-fit w-full flex-col-reverse justify-between rounded-md border px-4 py-2 md:flex-row md:items-center"
>
<div class="w-full md:w-[75%] lg:w-[80%]">
<p class="mb-5 w-4/6 font-normal lg:text-xl">
{$currentOrg.customization.dashboard.bannerText
? $currentOrg.customization.dashboard.bannerText
: $t('dashboard.lms_dashboard_hero')}
</p>
<Button onclick={() => goto(resolve('/lms/mylearning', {}))}>
{$t('dashboard.continue_learning')}
</Button>
</div>
<img
src={$currentOrg.customization.dashboard.bannerImage
? $currentOrg.customization.dashboard.bannerImage
: '/images/student-learning.svg'}
alt="student Learning Pictogram"
class="mb-3 aspect-square size-48 md:mb-0 md:block"
/>
</div>
<img
src={$currentOrg.customization.dashboard.bannerImage
? $currentOrg.customization.dashboard.bannerImage
: '/images/student-learning.svg'}
alt="student Learning Pictogram"
class="mb-3 aspect-square size-48 md:mb-0 md:block"
/>
</div>
</BlurFade>
<section class="flex w-full flex-col md:gap-4 lg:flex-row">
<div class="mt-10 w-full lg:w-[50%] xl:mt-2">
<BlurFade delay={0.1} once class="mt-10 w-full lg:w-[50%] xl:mt-2">
<Learning />
</div>
<div class="mt-10 w-full lg:w-[50%] xl:mt-2">
</BlurFade>
<BlurFade delay={0.2} once class="mt-10 w-full lg:w-[50%] xl:mt-2">
<p class="pb-3 text-base font-semibold text-[#040F2D] dark:text-white">
{$t('dashboard.your_progress')}
</p>
@@ -88,5 +93,5 @@
</h1>
</div>
</div>
</div>
</BlurFade>
</section>
@@ -0,0 +1,5 @@
import { classroomio, type InferResponseType } from '$lib/utils/services/api';
export type GetPendingOrgInviteRequest = (typeof classroomio.invite.organization)['pending']['$get'];
type GetPendingOrgInviteResponse = Extract<InferResponseType<GetPendingOrgInviteRequest>, { success: true }>;
export type PendingOrgInvite = NonNullable<GetPendingOrgInviteResponse['data']>;