@edpire/sdk 0.7.0 → 0.8.0

package/dist/index.d.mts

@@ -176,6 +176,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[];
             }>;
         }>;
     }>;
@@ -252,6 +258,66 @@ interface EmbedInstance {
     /** Unmounts the assessment player and cleans up event listeners. */
     unmount: () => void;
 }
+/**
+ * Response of `GET /api/v1/submissions/{id}/review`: one finished attempt, with
+ * everything needed to draw it as the corrected paper. Fetch it on your server
+ * (it needs an API key with `read:results`), send it to the browser, and pass it
+ * to `EdpireAssessment.review()` unchanged.
+ */
+interface SubmissionReview {
+    submission: {
+        id: string;
+        assessment_id: string;
+        learner_ref: string | null;
+        status: string;
+        attempt_number: number;
+        /** How many attempts this learner has made at this assessment, this one included. */
+        total_attempts: number;
+        score: number;
+        max_score: number;
+        percentage: number;
+        passed: boolean;
+        passing_score_percent: number;
+        is_fully_graded: boolean;
+        /**
+         * True while a teacher still has open responses to grade. `score`,
+         * `percentage` and `passed` are provisional until it turns false, and the
+         * player hides them.
+         */
+        awaiting_manual_grading: boolean;
+        submitted_at: string | null;
+    };
+    assessment: AssessmentLoaderResponse["assessment"];
+    meta: Omit<AssessmentLoaderResponse["meta"], "type">;
+    branding?: TakeBranding | null;
+    /** The learner's answers, in the shape the player collected them. */
+    answers: {
+        exerciseAnswers: Array<{
+            exerciseId: string;
+            questionAnswers: Array<{
+                questionId: string;
+                answers: RuntimeAnswer[];
+            }>;
+        }>;
+    };
+    exercise_feedback: EmbedResult["exercise_feedback"];
+}
+interface ReviewOptions {
+    /** The response of `GET /api/v1/submissions/{id}/review`, passed through untouched. */
+    review: SubmissionReview;
+    /** Where to mount the corrected paper. CSS selector string or DOM element. */
+    container: string | HTMLElement;
+    /** Player UI language. Defaults to the assessment's own language. */
+    locale?: ShellLocale;
+    /** Branding overrides. Defaults to the org branding carried in the review. */
+    branding?: TakeBranding;
+    /** Geometry of the question column. Same as `MountOptions.layout`. */
+    layout?: ShellLayout;
+    /** Shows a back button in the top bar and calls this when it is clicked. */
+    onBack?: () => void;
+    /** Custom label for the back button. */
+    backLabel?: string;
+}
 interface RenderQuestionOptions {
     /**
      * DOM element or CSS selector string to mount into.
@@ -273,6 +339,11 @@ interface RenderQuestionOptions {
      * Pre-fill answers.
      */
     initialAnswers?: RuntimeAnswer[];
+    /**
+     * Lock the question: answers show but cannot be changed. Since 0.8.0. For
+     * reviewing a past attempt one question at a time; see `flattenReview()`.
+     */
+    readOnly?: boolean;
     /**
      * Text direction for the question container.
      */
@@ -298,6 +369,55 @@ interface QuestionInstance {
      */
     unmount(): void;
 }
+interface AssessmentLoaderResponse {
+    assessment: {
+        /**
+         * Assessment-level annex — reading texts, figures, formula sheets. The
+         * player shows it as a side panel on wide screens and a drawer on narrow
+         * ones. Null when the assessment has none.
+         */
+        annex?: unknown | null;
+        exercises: Array<{
+            id: string;
+            sharedContext: unknown | null;
+            questions: Array<{
+                id: string;
+                version: "1.0";
+                content: unknown;
+                /** Sent by the content loader, not by a review. Nothing in the player reads either. */
+                points?: number;
+                sequenceNumber?: number;
+                answerKeys: never[];
+            }>;
+        }>;
+    };
+    meta: {
+        id: string;
+        title: string;
+        type: string;
+        category?: string | null;
+        /**
+         * The assessment's learner-facing language, which also decides text
+         * direction. The player uses this unless the host passes `locale`
+         * explicitly, so a French assessment reads left-to-right even when embedded
+         * in a right-to-left product.
+         */
+        language?: "en" | "fr" | "ar";
+        settings: {
+            time_limit_minutes: number | null;
+            passing_score_percent: number;
+            allowed_attempts: number;
+            show_solutions: string;
+        };
+    };
+    attempt_info: {
+        attempt_number: number;
+        can_retry: boolean;
+        attempts_remaining: number | null;
+    };
+    /** Org branding loaded server-side. May be overridden by MountOptions.branding. */
+    branding?: TakeBranding | null;
+}
 
 /** Flat per-question answer collected during a custom player session. */
 interface StoredAnswer {
@@ -447,6 +567,71 @@ declare function flattenAssessment(assessment: Assessment): FlatStep[];
 
 declare function renderQuestion(options: RenderQuestionOptions): QuestionInstance;
 
+/**
+ * flattenReview: a finished attempt as a linear sequence of steps, one per
+ * question, each ready to hand to `renderQuestion()` read-only.
+ *
+ * The review counterpart of `flattenAssessment()`. Where the full paper
+ * (`EdpireAssessment.review()`) draws the whole attempt at once, this is for
+ * flows that show one question per screen, Arcade-style, and want the learner
+ * to page back through a past attempt the same way they took it.
+ *
+ * @example
+ * const review = await fetch(`/api/attempts/${id}/review`).then((r) => r.json())
+ * const steps = flattenReview(review)
+ *
+ * const q = renderQuestion({
+ *   container: "#question",
+ *   content: steps[i].content,
+ *   initialAnswers: steps[i].answers,
+ *   feedback: steps[i].feedback,
+ *   readOnly: true,
+ * })
+ * // steps[i].status, steps[i].score / steps[i].maxScore for your own chrome
+ *
+ * Pure: no React, no DOM. Also exported from `@edpire/sdk/core`.
+ */
+
+interface ReviewStep {
+    exerciseId: string;
+    questionId: string;
+    /** ContentAST. Pass to renderQuestion's `content`. */
+    content: unknown;
+    /**
+     * The exercise's shared context (reading passage, figure, worked example),
+     * or null. Unlike `flattenAssessment()`, carried on every step: a
+     * comprehension question reviewed without its passage makes no sense.
+     * Render it with renderQuestion too; it is plain content.
+     */
+    sharedContext: unknown | null;
+    /** What the learner answered. Pass to renderQuestion's `initialAnswers`. */
+    answers: RuntimeAnswer[];
+    /**
+     * The marking, in the same shape POST /check returns, so it goes straight
+     * into renderQuestion's `feedback`. Includes the expected answer on anything
+     * missed and the teacher's comment on an open response.
+     */
+    feedback: Record<string, unknown>;
+    score: number;
+    maxScore: number;
+    /**
+     * The question as a whole. `awaiting_review` while a teacher has yet to mark
+     * any part of it; its score is then provisional. `unscored` when it is worth
+     * nothing (no answerable input, or 0 points): there was nothing to get
+     * wrong, so do not show it as wrong.
+     */
+    status: "correct" | "partial" | "incorrect" | "awaiting_review" | "unscored";
+    /** 0-based position, in the order the assessment presents questions. */
+    index: number;
+}
+/**
+ * The order is the assessment's (exercises, then questions within each), not
+ * the order a shuffled Arcade attempt happened to show. Edpire does not record
+ * the order an attempt was presented in; store it yourself if you need to
+ * replay it exactly.
+ */
+declare function flattenReview(review: SubmissionReview): ReviewStep[];
+
 declare const EdpireAssessment: {
     /**
      * Mount an Edpire assessment into the given container.
@@ -463,6 +648,21 @@ declare const EdpireAssessment: {
      * })
      */
     mount(options: MountOptions): EmbedInstance;
+    /**
+     * Render a finished attempt as the corrected paper: the learner's answers,
+     * locked, with every mark, expected answer and teacher comment.
+     *
+     * Pass the response of `GET /api/v1/submissions/{id}/review` unchanged. Your
+     * server fetches it with an API key, after checking the attempt belongs to
+     * the signed-in learner. No token, and no request from the browser to Edpire,
+     * so the origin allow-list does not apply.
+     *
+     * @example
+     * const review = await fetch(`/api/attempts/${submissionId}/review`).then((r) => r.json())
+     * const view = EdpireAssessment.review({ review, container: "#paper" })
+     * view.unmount()
+     */
+    review(options: ReviewOptions): EmbedInstance;
 };
 
-export { EdpireAssessment, type EmbedError, type EmbedInstance, type EmbedResult, type ExerciseFeedbackData, type FlatStep, type MountOptions, type OverlayConfig, type QuestionInstance, type RenderQuestionOptions, type ShellLayout, type ShellLocale, type SpinnerTheme, type StoredAnswer, type SubmitResult, type TakeBranding, buildSubmitPayload, flattenAssessment, renderQuestion };
+export { EdpireAssessment, type EmbedError, type EmbedInstance, type EmbedResult, type ExerciseFeedbackData, type FlatStep, type MountOptions, type OverlayConfig, type QuestionInstance, type RenderQuestionOptions, type ReviewOptions, type ReviewStep, type ShellLayout, type ShellLocale, type SpinnerTheme, type StoredAnswer, type SubmissionReview, type SubmitResult, type TakeBranding, buildSubmitPayload, flattenAssessment, flattenReview, renderQuestion };