@edpire/sdk 0.6.12 → 0.8.0

package/CHANGELOG.md

@@ -0,0 +1,113 @@
+# Changelog
+
+All notable changes to `@edpire/sdk`.
+
+This file starts at 0.7.0. Earlier versions are recoverable from the git history
+of `packages/sdk`, but were never written up, which is the reason this exists:
+integrators pin a version and had no way to tell what a bump would change.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and
+the package follows [semantic versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.8.0] - 2026-09-23
+
+### Added
+
+- **`EdpireAssessment.review({ review, container })`**: reopens a finished
+  attempt as the corrected paper. The learner's answers are replayed into
+  locked questions, with every mark, the expected answer on anything missed,
+  and the teacher's comments on open responses. It is the screen the player
+  shows on submit, available again afterwards.
+
+  ```javascript
+  const review = await fetch(`/api/attempts/${id}/review`).then((r) => r.json())
+  EdpireAssessment.review({ review, container: "#paper" })
+  ```
+
+  `review` is the response of the new `GET /api/v1/submissions/{id}/review`,
+  passed through unchanged. Your server fetches it with an API key after
+  checking ownership, so there is no token and no browser request to Edpire,
+  and the origin allow-list does not apply.
+
+- **`flattenReview(review)`**: the same attempt as one step per question, for
+  flows that show one question per screen. Each step carries the content, the
+  learner's answers, feedback in `/check`'s shape, the score and a status, plus
+  the exercise's shared context. Pure, so also in `@edpire/sdk/core` and on the
+  CDN global.
+
+  ```javascript
+  const steps = flattenReview(review)
+  renderQuestion({ container, content: steps[i].content, initialAnswers: steps[i].answers,
+                   feedback: steps[i].feedback, readOnly: true })
+  ```
+
+- **`readOnly`** on `renderQuestion()` and `EdpireQuestion`: answers show but
+  cannot change.
+
+- **`EdpireClient.getSubmissionReview(id, { learnerRef })`** for that fetch.
+  With `learnerRef`, a submission belonging to anyone else is a 404.
+
+- **`EdpireClient.getLearnerResults(ref, { assessmentId })`**: one
+  assessment's attempt history.
+
+- **`AssessmentShellProps.review`** and the **`ShellReview`** type, for React
+  consumers rendering the shell directly. **`SubmissionReview`**,
+  **`ReviewOptions`** and **`ReviewStep`** types.
+
+- **`teacher_feedback`** on `EmbedResult` node results. Only ever present in a
+  review: at submit time no teacher has marked anything yet.
+
+### Changed
+
+- The back button (`onBack`) now also shows in review mode. Before submission it
+  behaves as before.
+
+### Notes for integrators
+
+No breaking changes. Review needs the new endpoint, which is live on
+edpire.com from this release. See the attempt history guide:
+https://docs.edpire.com/developer/attempt-history
+
+## [0.7.0] - 2026-09-22
+
+### Added
+
+- **`layout.maxWidth`** on `MountOptions`, `EdpireAssessmentPlayerProps` and
+  `AssessmentShellProps`. The player fills the container you size, but inside
+  that the questions sat in a centred 768px column with no way to change it.
+  That is right when the player owns the page and wrong when it is embedded in
+  host chrome, where it reads as a column inside a column. Takes any CSS length
+  or `"none"`.
+
+  ```javascript
+  EdpireAssessment.mount({ token, container: "#root", layout: { maxWidth: "none" } })
+  ```
+
+  The default is unchanged at `"48rem"`, so no existing embed moves. It stays a
+  reading measure by default: 768px already yields roughly 70 to 90 characters
+  per line at the runtime's base size.
+
+  The value also drives the post-submit score banners, so they stay aligned with
+  the questions. When an assessment has an annex, wide viewports use a
+  two-column layout that already fills the container and only the narrow
+  breakpoint takes the value.
+
+- **`ShellLayout`** exported from `@edpire/sdk` and `@edpire/sdk/react`.
+
+- **Pre-submit warning for unanswered questions.** The confirm dialog now names
+  how many questions are not fully answered. It warns and never blocks: the
+  learner can still submit. Auto-submit on time expiry does not route through
+  the dialog. Translated in en, fr and ar.
+
+  A question counts as incomplete when any of its inputs is empty, so three of
+  four blanks filled is caught.
+
+### Notes for integrators
+
+No breaking changes. This is a minor bump only because it adds public API.
+
+If you have been working around the 768px column with your own CSS, for example
+by overriding `max-w-3xl` or forcing widths on the shell's children, remove it
+and pass `layout` instead. The class is gone: the width is now an inline style,
+because the shipped `shell.css` is pre-built and a consumer's width can never
+exist as a utility class in it.