@happyvertical/smrt-education 0.57.43 → 0.57.45

package/dist/question-printable.d.ts

@@ -0,0 +1,9 @@
+import { type GuardianWorksheetBundle, type LearnerWorksheetBundle } from './question-contracts.js';
+/**
+ * Learner copy. It takes the keyless learner bundle, whose type has no key,
+ * rubric or provenance members, so a key cannot reach the PDF.
+ */
+export declare function renderLearnerWorksheetPdf(bundle: LearnerWorksheetBundle, title: string): Promise<Uint8Array>;
+/** Guardian copy: the same layout plus answer keys, explanations and rubric summaries. */
+export declare function renderGuardianWorksheetPdf(bundle: GuardianWorksheetBundle, title: string): Promise<Uint8Array>;
+//# sourceMappingURL=question-printable.d.ts.map

package/dist/question-printable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question-printable.d.ts","sourceRoot":"","sources":["../src/question-printable.ts"],"names":[],"mappings":"AAQA,OAAO,EAEL,KAAK,uBAAuB,EAE5B,KAAK,sBAAsB,EAO5B,MAAM,yBAAyB,CAAC;AAkUjC;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,sBAAsB,EAC9B,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,UAAU,CAAC,CAMrB;AAED,0FAA0F;AAC1F,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,uBAAuB,EAC/B,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,UAAU,CAAC,CAMrB"}

package/dist/question-render.d.ts

@@ -0,0 +1,20 @@
+import type { GuardianWorksheetBundle, LearnerWorksheetBundle, LessonLayoutParams, LessonQuestionRefInput, QuestionRevisionView } from './question-contracts.js';
+export declare const canonical: (value: unknown) => string;
+/**
+ * Deterministic id of one worksheet layout: the ordered question revisions with
+ * their placement plus the layout params. Printable and online renders of the
+ * same inputs share it, so a later scan can be matched to the exact revisions.
+ */
+export declare function worksheetVersionId(refs: readonly LessonQuestionRefInput[], layoutParams?: LessonLayoutParams): string;
+export interface WorksheetRenderInput {
+    lessonRevisionId: string;
+    refs: readonly LessonQuestionRefInput[];
+    layoutParams?: LessonLayoutParams;
+    /** The pinned revisions, by id. Every ref must resolve. */
+    revisions: ReadonlyMap<string, QuestionRevisionView>;
+}
+/** Render input for learners (printable or online); answer keys are excluded by type. */
+export declare function buildLearnerWorksheet(input: WorksheetRenderInput): LearnerWorksheetBundle;
+/** Guardian/author bundle: the same items plus keys, rubrics and provenance. */
+export declare function buildGuardianWorksheet(input: WorksheetRenderInput): GuardianWorksheetBundle;
+//# sourceMappingURL=question-render.d.ts.map

package/dist/question-render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question-render.d.ts","sourceRoot":"","sources":["../src/question-render.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,uBAAuB,EAEvB,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC,eAAO,MAAM,SAAS,GAAI,OAAO,OAAO,KAAG,MAOxC,CAAC;AAEJ;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,SAAS,sBAAsB,EAAE,EACvC,YAAY,GAAE,kBAAuB,GACpC,MAAM,CAWR;AAwBD,MAAM,WAAW,oBAAoB;IACnC,gBAAgB,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,SAAS,sBAAsB,EAAE,CAAC;IACxC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,2DAA2D;IAC3D,SAAS,EAAE,WAAW,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CACtD;AAUD,yFAAyF;AACzF,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,oBAAoB,GAC1B,sBAAsB,CASxB;AAED,gFAAgF;AAChF,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,oBAAoB,GAC1B,uBAAuB,CAgBzB"}

package/dist/question-response-contracts.d.ts

@@ -0,0 +1,54 @@
+import { CourseAuthoringError } from './course-authoring-contracts.js';
+import type { GuardianWorksheetBundle, LearnerWorksheetBundle, QuestionAssistance, QuestionCompletionMode } from './question-contracts.js';
+/**
+ * The learner's answer to one question. Only these members are accepted so a
+ * response can never smuggle other data; `choiceIds` must name the revision's
+ * choices and `parts` keys its subparts.
+ */
+export interface QuestionResponseContent {
+    text?: string;
+    numeric?: number;
+    choiceIds?: string[];
+    parts?: Record<string, {
+        text?: string;
+        numeric?: number;
+        choiceIds?: string[];
+    }>;
+}
+/** Data-only view of one append-only response row. It carries no key or rubric. */
+export interface QuestionResponseView {
+    id: string;
+    learnerId: string;
+    enrollmentId: string;
+    lessonRevisionId: string | null;
+    questionRevisionId: string;
+    worksheetVersionId: string;
+    /** Groups one attempt and its corrections. */
+    episodeId: string;
+    attemptNumber: number;
+    /** The response this row corrects, or null for a new attempt. */
+    previousResponseId: string | null;
+    completionMode: QuestionCompletionMode;
+    assistance: QuestionAssistance;
+    response: QuestionResponseContent;
+    actorUserId: string;
+    /** True when the author is not the learner (a guardian correction). */
+    byGuardian: boolean;
+    recordedAt: string;
+}
+/** Learner reads get the keyless bundle; guardians get the keyed one. */
+export interface LessonQuestionResponses {
+    worksheet: LearnerWorksheetBundle | GuardianWorksheetBundle;
+    responses: QuestionResponseView[];
+}
+export declare class QuestionResponseValidationError extends CourseAuthoringError {
+    constructor(message: string);
+}
+/** The question revision is not in the enrollment's effective lesson set. */
+export declare class QuestionResponseScopeError extends CourseAuthoringError {
+    constructor();
+}
+export declare class QuestionResponseNotFoundError extends CourseAuthoringError {
+    constructor();
+}
+//# sourceMappingURL=question-response-contracts.d.ts.map

package/dist/question-response-contracts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question-response-contracts.d.ts","sourceRoot":"","sources":["../src/question-response-contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,yBAAyB,CAAC;AAEjC;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CACZ,MAAM,EACN;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAC1D,CAAC;CACH;AAED,mFAAmF;AACnF,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,iEAAiE;IACjE,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,cAAc,EAAE,sBAAsB,CAAC;IACvC,UAAU,EAAE,kBAAkB,CAAC;IAC/B,QAAQ,EAAE,uBAAuB,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,uEAAuE;IACvE,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yEAAyE;AACzE,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,sBAAsB,GAAG,uBAAuB,CAAC;IAC5D,SAAS,EAAE,oBAAoB,EAAE,CAAC;CACnC;AAED,qBAAa,+BAAgC,SAAQ,oBAAoB;gBAC3D,OAAO,EAAE,MAAM;CAG5B;AACD,6EAA6E;AAC7E,qBAAa,0BAA2B,SAAQ,oBAAoB;;CAOnE;AACD,qBAAa,6BAA8B,SAAQ,oBAAoB;;CAItE"}

package/dist/question-response-service.d.ts

@@ -0,0 +1,63 @@
+import type { DatabaseInterface } from '@happyvertical/sql';
+import { type LearnerRequest, LearnerService } from './learner-service.js';
+import { type LearnerLessonView, type QuestionAssistance } from './question-contracts.js';
+import { type LessonQuestionResponses, type QuestionResponseContent, type QuestionResponseView } from './question-response-contracts.js';
+type LessonRequest = LearnerRequest & {
+    enrollmentId: string;
+    lessonId: string;
+};
+export type RecordQuestionResponseRequest = LessonRequest & {
+    questionRevisionId: string;
+    requestKey: string;
+    response: QuestionResponseContent;
+    /** Learners record online responses; printable/interactive need their own path. */
+    completionMode?: 'online';
+    assistance?: QuestionAssistance;
+    /** Names the response this one corrects; omit for a new attempt. */
+    correctsResponseId?: string;
+};
+export type GuardianCorrectionRequest = LessonRequest & {
+    questionRevisionId: string;
+    requestKey: string;
+    correctsResponseId: string;
+    /** Omit to record assistance only: the corrected response's answer is kept. */
+    response?: QuestionResponseContent;
+    assistance?: QuestionAssistance;
+};
+/**
+ * Guarded write path for learner question responses (SMRT #4515). Extends the
+ * learner boundary: the actor must be the learner (own enrollment) to record,
+ * or the authorized guardian to review/correct; the question revision must be in
+ * the enrollment's effective lesson set. Rows are append-only; question
+ * revisions are never written.
+ */
+export declare class QuestionResponseService extends LearnerService {
+    protected createTransactionService(db: DatabaseInterface): this;
+    /** The learner records an online attempt, or corrects their own response. */
+    recordResponse(request: RecordQuestionResponseRequest): Promise<QuestionResponseView>;
+    /** A guardian appends a correction and/or assistance note; never overwrites. */
+    recordGuardianCorrection(request: GuardianCorrectionRequest): Promise<QuestionResponseView>;
+    /**
+     * The lesson's questions and recorded responses. The audience follows the
+     * actor: the learner gets the keyless bundle, an authorized guardian the
+     * keyed one. It is never a request choice.
+     */
+    readLessonResponses(request: LessonRequest): Promise<LessonQuestionResponses>;
+    /**
+     * One effective lesson for rendering, learner-safe. The audience is the same
+     * for the learner and an authorized guardian (`education.learner.read`, own or
+     * guardian relationship): the keyless bundle and an allowlisted lesson, never
+     * answer keys, rubrics, provenance, materials, source locators or the body of
+     * a personal-use-copy lesson. Keys are read through `QuestionAuthoringService.
+     * readReleasedLesson` (`read-draft`). A lesson outside the enrollment's
+     * effective set is a `QuestionResponseScopeError`.
+     */
+    readReleasedLesson(request: LessonRequest): Promise<LearnerLessonView>;
+    private view;
+    /** Effective lesson row to its immutable lesson revision's ordered question refs. */
+    private lessonQuestions;
+    private revisionRow;
+    private write;
+}
+export {};
+//# sourceMappingURL=question-response-service.d.ts.map

package/dist/question-response-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question-response-service.d.ts","sourceRoot":"","sources":["../src/question-response-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAI5D,OAAO,EAEL,KAAK,cAAc,EACnB,cAAc,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,KAAK,iBAAiB,EAItB,KAAK,kBAAkB,EAOxB,MAAM,yBAAyB,CAAC;AAWjC,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAI5B,KAAK,oBAAoB,EAC1B,MAAM,kCAAkC,CAAC;AAqH1C,KAAK,aAAa,GAAG,cAAc,GAAG;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AACF,MAAM,MAAM,6BAA6B,GAAG,aAAa,GAAG;IAC1D,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,uBAAuB,CAAC;IAClC,mFAAmF;IACnF,cAAc,CAAC,EAAE,QAAQ,CAAC;IAC1B,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,oEAAoE;IACpE,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AACF,MAAM,MAAM,yBAAyB,GAAG,aAAa,GAAG;IACtD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,uBAAuB,CAAC;IACnC,UAAU,CAAC,EAAE,kBAAkB,CAAC;CACjC,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,uBAAwB,SAAQ,cAAc;cACtC,wBAAwB,CAAC,EAAE,EAAE,iBAAiB,GAAG,IAAI;IAQxE,6EAA6E;IACvE,cAAc,CAClB,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,oBAAoB,CAAC;IAIhC,gFAAgF;IAC1E,wBAAwB,CAC5B,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,oBAAoB,CAAC;IAIhC;;;;OAIG;IACG,mBAAmB,CACvB,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,uBAAuB,CAAC;IA2DnC;;;;;;;;OAQG;IACG,kBAAkB,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA0C5E,OAAO,CAAC,IAAI;IAuBZ,qFAAqF;YACvE,eAAe;YA6Cf,WAAW;YAYX,KAAK;CA0IpB"}

package/dist/question-rubric.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Pure rubric/answer-key shapes shared by the question models, the authoring
+ * service and `Grade`. Importing nothing keeps `submissions.ts` cycle-free.
+ */
+export interface QuestionRubricCriterion {
+    id: string;
+    label: string;
+    /** Positive maximum points for this criterion. */
+    maxPoints: number;
+}
+export interface QuestionRubric {
+    criteria: QuestionRubricCriterion[];
+}
+/** Returns a normalized rubric or throws `Error` naming the first problem. */
+export declare function parseQuestionRubric(value: unknown): QuestionRubric;
+/**
+ * Validates `Grade.rubricResults` against the exact revision's rubric. A value
+ * is a finite number or `{ points: number }`, never above the criterion's
+ * maximum. Empty results stay empty (unscored is never zero); results against a
+ * revision without a rubric are rejected.
+ */
+export declare function validateRubricResults(rubricJson: string | null | undefined, results: Record<string, unknown>): void;
+//# sourceMappingURL=question-rubric.d.ts.map

package/dist/question-rubric.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"question-rubric.d.ts","sourceRoot":"","sources":["../src/question-rubric.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,uBAAuB,EAAE,CAAC;CACrC;AAID,8EAA8E;AAC9E,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,CAuBlE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACrC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,IAAI,CAqBN"}