@edpire/sdk 0.7.0 → 0.8.0

package/dist/react.d.mts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { RuntimeAnswer, QuestionRuntimeProps, AssessmentContent, AssessmentAnswers } from '@youssefalmia/edpire-runtime';
+import { RuntimeAnswer, AssessmentAnswers, QuestionRuntimeProps, AssessmentContent } from '@youssefalmia/edpire-runtime';
 export { RuntimeAnswer } from '@youssefalmia/edpire-runtime';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { RichContent } from '@youssefalmia/edpire-schema/authoring';
@@ -40,6 +40,11 @@ interface EdpireQuestionProps {
      * Pre-fill answers — useful for restoring state when navigating back.
      */
     initialAnswers?: RuntimeAnswer[];
+    /**
+     * Lock the question: answers show but cannot be changed. For reviewing a
+     * finished attempt, with `initialAnswers` and `feedback` from `flattenReview()`.
+     */
+    readOnly?: boolean;
     /**
      * CSS class added to the question root div.
      */
@@ -135,6 +140,13 @@ interface ExerciseFeedbackData {
     exerciseId: string;
     questions: QuestionFeedback[];
 }
+/** What the shell needs to open on a finished attempt. See `AssessmentShellProps.review`. */
+interface ShellReview {
+    /** The answers given in the attempt, in the shape `onSubmit` receives them. */
+    answers: AssessmentAnswers;
+    /** The attempt's marking. Drives the score banner and every per-node mark. */
+    result: SubmitResult;
+}
 interface SubmitResult {
     submissionId: string;
     totalScore: number;
@@ -226,6 +238,12 @@ interface EmbedResult {
                         rightId: string;
                     }>;
                 };
+                /**
+                 * The teacher's written feedback on an open response. Only ever present
+                 * in a review (`GET /submissions/{id}/review`), since at submit time no
+                 * teacher has graded anything yet.
+                 */
+                teacher_feedback?: RichContent[];
             }>;
         }>;
     }>;
@@ -375,11 +393,17 @@ interface AssessmentShellProps {
     startedAt?: string;
     /** Called when the learner submits. Should throw on error. */
     onSubmit: (answers: AssessmentAnswers) => Promise<SubmitResult>;
+    /**
+     * Opens the shell on a finished attempt instead of a blank paper: already
+     * submitted, the learner's answers filled in and locked, marking shown. There
+     * is no way to submit from here, so `onSubmit` is never called.
+     */
+    review?: ShellReview;
     /** Called when the learner clicks "View Full Report". Omit to hide the button. */
     onViewReport?: (result: SubmitResult) => void;
     /** Custom label for the post-submit redirect button (overrides default). */
     reportLabel?: string;
-    /** Called when the learner clicks the back button (shown only BEFORE submission). */
+    /** Called when the learner clicks the back button (shown before submission, and throughout a review). */
     onBack?: () => void;
     /** Custom label for the back button (default: localized "Back"). */
     backLabel?: string;
@@ -417,6 +441,6 @@ interface AssessmentShellProps {
      */
     fallbackLogoUrl?: string;
 }
-declare function AssessmentShell({ assessment, meta, locale, branding, timeLimitMinutes, startedAt, onSubmit, onViewReport, reportLabel, onBack, backLabel, allowReset, onReset, overlayConfig, contained, layout, onClose, mediaHandler, onAddAnnex, fallbackLogoUrl, }: AssessmentShellProps): react_jsx_runtime.JSX.Element;
+declare function AssessmentShell({ assessment, meta, locale, branding, timeLimitMinutes, startedAt, onSubmit, review, onViewReport, reportLabel, onBack, backLabel, allowReset, onReset, overlayConfig, contained, layout, onClose, mediaHandler, onAddAnnex, fallbackLogoUrl, }: AssessmentShellProps): react_jsx_runtime.JSX.Element;
 
-export { AssessmentShell, type AssessmentShellProps, EdpireAssessmentPlayer, type EdpireAssessmentPlayerProps, EdpireQuestion, type EdpireQuestionProps, type ExerciseFeedbackData, type NodeDetail, type NodeFeedback, type OverlayConfig, type QuestionFeedback, type ShellLayout, type ShellLocale, type SpinnerTheme, type SubmitResult, type TakeBranding };
+export { AssessmentShell, type AssessmentShellProps, EdpireAssessmentPlayer, type EdpireAssessmentPlayerProps, EdpireQuestion, type EdpireQuestionProps, type ExerciseFeedbackData, type NodeDetail, type NodeFeedback, type OverlayConfig, type QuestionFeedback, type ShellLayout, type ShellLocale, type ShellReview, type SpinnerTheme, type SubmitResult, type TakeBranding };