@digabi/exam-engine-core 23.9.1-alpha.0 → 23.9.2

package/dist/src/types/ExamServerAPI.d.ts

@@ -0,0 +1,78 @@
+import { ExamAnswer, QuestionId } from './ExamAnswer';
+export type SaveState = 'initial' | 'saving' | 'saved';
+/**
+ * CAS status is a state machine with three states.
+ *
+ * ```
+ * +---------+       +--------+      +-------+
+ * |forbidden| <---> |allowing| ---> |allowed|
+ * +---------+       +--------+      +-------+
+ * ```
+ *
+ * When the user clicks the "Palauta A-osa" button, we start a 60s countdown
+ * and transition the state from `'forbidden'` to `'allowing'`. When the timer reaches
+ * zero, we transition the state from from `'allowing'` to `'allowed'`. Cancelling
+ * the countdown transitions the state back from `'allowing'` to `'forbidden'`.
+ */
+export type CasStatus = InitialCasStatus | 'allowing';
+export type InitialCasStatus = 'allowed' | 'forbidden';
+export type RestrictedAudioId = number;
+export type AudioPlaybackError = 
+/** The user has already accessed this restricted audio */
+'already-accessed'
+/** There already is an audio file playing */
+ | 'already-playing'
+/** Other error, e.g. a network issue */
+ | 'other-error';
+export type AudioPlaybackResponse = 'ok' | AudioPlaybackError;
+export interface RestrictedAudioPlaybackStats {
+    /** An unique identifier for each restricted audio element */
+    restrictedAudioId: RestrictedAudioId;
+    /** Number of times it has been listened to. */
+    times: number;
+}
+export interface ExamServerAPI {
+    /**
+     * Setting CAS status to allowed will lock the answers for each section where
+     * the use of CAS software is forbidden.
+     *
+     * All state transitions are not legal (for example, you may not disable CAS
+     * software after they have been allowed), so the function returns the CAS
+     * status that the server decided upon.
+     */
+    setCasStatus: (casStatus: CasStatus) => Promise<CasStatus>;
+    /** Retrieve the latest answer for each question */
+    getAnswers: () => Promise<ExamAnswer[]>;
+    /** Save a new answer to the server */
+    saveAnswer: (answer: ExamAnswer) => Promise<void>;
+    /**
+     * Play a non-restricted audio file. Right now, this is only used by the
+     * audio test. The Promise should be resolved with `'ok'` when playback starts
+     * or with an error response if an error occurs.
+     */
+    playAudio: (src: string) => Promise<AudioPlaybackResponse>;
+    /**
+     * Play a restricted audio file. The promise should be resolved with `'ok'`
+     * when the playback starts or with an error response if an error occurs.
+     *
+     * @param restrictedAudioId A number that uniquely identifies each restricted audio element.
+     * @param playbackTimes How many times this audio has been listened to already.
+     */
+    playRestrictedAudio: (src: string, restrictedAudioId: number, playbackTimes: number) => Promise<AudioPlaybackResponse>;
+    /**
+     * Get restricted audio file in a blob. The promise should be resolved with blob
+     * when the audio file has be loaded or rejected with an error response if an error occurs.
+     *
+     * @param restrictedAudioId A number that uniquely identifies each restricted audio element.
+     * @param playbackTimes How many times this audio has been listened to already.
+     */
+    getRestrictedAudio: (src: string, restrictedAudioId: number, playbackTimes: number) => Promise<Blob>;
+    /** Select another answer version from answer history. Return undefined to cancel. Optional feature. */
+    selectAnswerVersion?: (questionId: QuestionId, questionTitle: string) => Promise<ExamAnswer | undefined>;
+    /** Save screenshot to server. Should return the URL to the saved screenshot. */
+    saveScreenshot: (questionId: QuestionId, screenshot: Blob) => Promise<string>;
+    examineExam?: () => void;
+    /** Log client activity to server. Message format is free. Optional feature. */
+    logActivity?: (message: string) => void;
+}
+//# sourceMappingURL=ExamServerAPI.d.ts.map

package/dist/src/types/ExamServerAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExamServerAPI.d.ts","sourceRoot":"","sources":["../../../src/types/ExamServerAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAErD,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAA;AACtD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,SAAS,GAAG,gBAAgB,GAAG,UAAU,CAAA;AACrD,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,WAAW,CAAA;AACtD,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAA;AACtC,MAAM,MAAM,kBAAkB;AAC5B,0DAA0D;AACxD,kBAAkB;AACpB,6CAA6C;GAC3C,iBAAiB;AACnB,wCAAwC;GACtC,aAAa,CAAA;AACjB,MAAM,MAAM,qBAAqB,GAAG,IAAI,GAAG,kBAAkB,CAAA;AAE7D,MAAM,WAAW,4BAA4B;IAC3C,6DAA6D;IAC7D,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,aAAa;IAC5B;;;;;;;OAOG;IACH,YAAY,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,SAAS,CAAC,CAAA;IAC1D,mDAAmD;IACnD,UAAU,EAAE,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IACvC,sCAAsC;IACtC,UAAU,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACjD;;;;OAIG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAC1D;;;;;;OAMG;IACH,mBAAmB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAEtH;;;;;;OAMG;IACH,kBAAkB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACpG,uGAAuG;IACvG,mBAAmB,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;IACxG,gFAAgF;IAChF,cAAc,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7E,WAAW,CAAC,EAAE,MAAM,IAAI,CAAA;IACxB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;CACxC"}

package/dist/src/types/ExamServerAPI.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ExamServerAPI.js.map

package/dist/src/types/ExamServerAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExamServerAPI.js","sourceRoot":"","sources":["../../../src/types/ExamServerAPI.ts"],"names":[],"mappings":""}

package/dist/src/types/GradingStructure.d.ts

@@ -0,0 +1,40 @@
+export interface GradingStructure {
+    questions: GradingStructureQuestion[];
+}
+export type GradingStructureQuestion = TextQuestion | ChoiceGroupQuestion;
+export interface TextQuestion {
+    type: 'text';
+    id: number;
+    displayNumber: string;
+    maxScore: number;
+    maxLength?: number;
+    /**
+     * A tentative list of answers that will be accepted. Usually this is not the
+     * final list, since additional answers will be accepted during grading.
+     *
+     * If omitted, the question will be graded manually.
+     */
+    correctAnswers?: CorrectAnswer[];
+}
+export interface CorrectAnswer {
+    text: string;
+    score: number;
+}
+export interface ChoiceGroupQuestion {
+    type: 'choicegroup';
+    id: number;
+    displayNumber: string;
+    choices: ChoiceGroupChoice[];
+}
+export interface ChoiceGroupChoice {
+    id: number;
+    displayNumber: string;
+    type: 'choice';
+    options: ChoiceGroupOption[];
+}
+export interface ChoiceGroupOption {
+    id: number;
+    correct: boolean;
+    score: number;
+}
+//# sourceMappingURL=GradingStructure.d.ts.map

package/dist/src/types/GradingStructure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GradingStructure.d.ts","sourceRoot":"","sources":["../../../src/types/GradingStructure.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,wBAAwB,EAAE,CAAA;CACtC;AAED,MAAM,MAAM,wBAAwB,GAAG,YAAY,GAAG,mBAAmB,CAAA;AAEzE,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,aAAa,EAAE,CAAA;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,aAAa,CAAA;IACnB,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE,iBAAiB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,QAAQ,CAAA;IACd,OAAO,EAAE,iBAAiB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;CACd"}

package/dist/src/types/GradingStructure.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=GradingStructure.js.map

package/dist/src/types/GradingStructure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GradingStructure.js","sourceRoot":"","sources":["../../../src/types/GradingStructure.ts"],"names":[],"mappings":""}

package/dist/src/types/Score.d.ts

@@ -0,0 +1,92 @@
+import { QuestionId } from './ExamAnswer';
+export type AnswerId = number;
+export interface Score {
+    questionId: QuestionId;
+    answerId: AnswerId;
+    pregrading?: PregradingScore;
+    censoring?: CensoringScore;
+    inspection?: InspectionScore;
+    autograding?: AutogradedScore;
+}
+export interface AutogradedScore {
+    score: number;
+}
+export interface PregradingScore {
+    score?: number;
+    comment?: string;
+    annotations?: Annotation[];
+}
+export interface CensoringScore {
+    scores: Array<{
+        score: number;
+        shortCode: string;
+    }>;
+    annotations?: Annotation[];
+    nonAnswerDetails?: {
+        shortCode?: string;
+    };
+    comment?: string;
+}
+export interface InspectionScore {
+    score: number;
+    shortCodes: [string, string] | [string, string, string];
+}
+interface BaseAnnotation {
+    /** The message attached to the annotation */
+    message: string;
+    showPopup?: boolean;
+    markNumber?: string;
+}
+export interface TextAnnotation extends BaseAnnotation {
+    /** Legacy exams don't have this property, so it's marked as optional. */
+    type?: 'text';
+    /** A zero-indexed index of the character where the annotation starts at. Images are counted as 1 character. */
+    startIndex: number;
+    /** The length of the annotation in characters. Images are counted as 1 character. */
+    length: number;
+}
+export interface NewExamAnnotation extends TextAnnotation {
+    displayNumber: string;
+    annotationAnchor: string;
+    hidden: boolean;
+    selectedText: string;
+}
+export interface ExamAnnotation extends NewExamAnnotation {
+    annotationId: number;
+}
+interface ShapeAnnotation extends BaseAnnotation {
+    /** A 0-indexed number describing which <img /> in the answer the annotation is attached to. */
+    attachmentIndex: number;
+}
+export interface LineAnnotation extends ShapeAnnotation {
+    type: 'line';
+    /** Relative x-coordinate between 0 and 1. */
+    x1: number;
+    /** Relative y-coordinate between 0 and 1. */
+    y1: number;
+    /** Relative x-coordinate between 0 and 1. */
+    x2: number;
+    /** Relative y-coordinate between 0 and 1. */
+    y2: number;
+}
+export interface RectAnnotation extends ShapeAnnotation {
+    type: 'rect';
+    /** Relative x-coordinate between 0 and 1. */
+    x: number;
+    /** Relative y-coordinate between 0 and 1. */
+    y: number;
+    /** Relative width between 0 and 1. Note that `x + width` should be less or equal than 1. */
+    width: number;
+    /** Relative height between 0 and 1. Note that `y + height` should be less or equal than 1.*/
+    height: number;
+}
+/**
+ * Image annotations are annotations attached to a screenshot or a formula.
+ * They are described with relative `x` and `y`-coordinates, with `(0, 0)` being
+ * in the top left corner of the image and `(1, 1)` being in the bottom right
+ * corner of the image.
+ */
+export type ImageAnnotation = LineAnnotation | RectAnnotation;
+export type Annotation = TextAnnotation | ImageAnnotation;
+export {};
+//# sourceMappingURL=Score.d.ts.map

package/dist/src/types/Score.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Score.d.ts","sourceRoot":"","sources":["../../../src/types/Score.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAE7B,MAAM,WAAW,KAAK;IACpB,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,QAAQ,CAAA;IAClB,UAAU,CAAC,EAAE,eAAe,CAAA;IAC5B,SAAS,CAAC,EAAE,cAAc,CAAA;IAC1B,UAAU,CAAC,EAAE,eAAe,CAAA;IAC5B,WAAW,CAAC,EAAE,eAAe,CAAA;CAC9B;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACnD,WAAW,CAAC,EAAE,UAAU,EAAE,CAAA;IAC1B,gBAAgB,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;CACxD;AAED,UAAU,cAAc;IACtB,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,+GAA+G;IAC/G,UAAU,EAAE,MAAM,CAAA;IAClB,qFAAqF;IACrF,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD,aAAa,EAAE,MAAM,CAAA;IACrB,gBAAgB,EAAE,MAAM,CAAA;IACxB,MAAM,EAAE,OAAO,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;CACrB;AACD,MAAM,WAAW,cAAe,SAAQ,iBAAiB;IACvD,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,UAAU,eAAgB,SAAQ,cAAc;IAC9C,+FAA+F;IAC/F,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,6CAA6C;IAC7C,CAAC,EAAE,MAAM,CAAA;IACT,6CAA6C;IAC7C,CAAC,EAAE,MAAM,CAAA;IACT,4FAA4F;IAC5F,KAAK,EAAE,MAAM,CAAA;IACb,6FAA6F;IAC7F,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,cAAc,CAAA;AAE7D,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,eAAe,CAAA"}

package/dist/src/types/Score.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Score.js.map

package/dist/src/types/Score.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Score.js","sourceRoot":"","sources":["../../../src/types/Score.ts"],"names":[],"mappings":""}

package/dist/src/url.d.ts

@@ -0,0 +1,7 @@
+type URLOptions = Partial<Omit<URL, 'origin' | 'searchParams' | 'toJSON'>>;
+/**
+ * A helper function for constructing relative URLs for links within the exam
+ */
+export declare function url(path: string, options?: URLOptions): string;
+export {};
+//# sourceMappingURL=url.d.ts.map

package/dist/src/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../src/url.ts"],"names":[],"mappings":"AAEA,KAAK,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,GAAG,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAA;AAE1E;;GAEG;AACH,wBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,MAAM,CAM9D"}

package/dist/src/url.js

@@ -0,0 +1,12 @@
+import * as _ from 'lodash-es';
+/**
+ * A helper function for constructing relative URLs for links within the exam
+ */
+export function url(path, options) {
+    const u = new URL(path, 'http://example.com'); // hostname doesn't matter but it is required for URL constructor
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+    _.forEach(options, (v, k) => (u[k] = v));
+    const constructedPath = u.pathname + u.search + u.hash;
+    return path.startsWith('/') ? constructedPath : constructedPath.substr(1);
+}
+//# sourceMappingURL=url.js.map

package/dist/src/url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../src/url.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,WAAW,CAAA;AAI9B;;GAEG;AACH,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,OAAoB;IACpD,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAA,CAAC,iEAAiE;IAC/G,sEAAsE;IACtE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAE,CAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACjD,MAAM,eAAe,GAAG,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAA;IACtD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AAC3E,CAAC"}

package/dist/src/useCached.d.ts

@@ -0,0 +1,3 @@
+/** Like `useMemo`, but guaranteed never to be reinitialized. Doesn't support dependencies. */
+export declare function useCached<T>(fn: () => T): T;
+//# sourceMappingURL=useCached.d.ts.map

package/dist/src/useCached.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCached.d.ts","sourceRoot":"","sources":["../../src/useCached.ts"],"names":[],"mappings":"AAEA,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAE3C"}

package/dist/src/useCached.js

@@ -0,0 +1,6 @@
+import { useState } from 'react';
+/** Like `useMemo`, but guaranteed never to be reinitialized. Doesn't support dependencies. */
+export function useCached(fn) {
+    return useState(fn)[0];
+}
+//# sourceMappingURL=useCached.js.map

package/dist/src/useCached.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCached.js","sourceRoot":"","sources":["../../src/useCached.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAEhC,8FAA8F;AAC9F,MAAM,UAAU,SAAS,CAAI,EAAW;IACtC,OAAO,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;AACxB,CAAC"}

package/dist/src/utils.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+/**
+ * Maps an array, skipping the value if `fn` returns `undefined`.
+ *
+ * @example mapMaybe(array, fn) ≡ array.map(fn).filter(v => v !== undefined)
+ */
+export declare function mapMaybe<T, U>(array: T[], fn: (value: T, index: number) => U | undefined): U[];
+/**
+ * Insert a separator between each element of the array.
+ *
+ * @example intersperse(',', ['a', 'b', 'c']) ≡ ['a', ',', 'b', ',' 'c']
+ */
+export declare function intersperse<T>(separator: T, array: T[]): T[];
+export declare function isWhitespace(node: React.ReactNode): boolean;
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,CAAC,GAAG,SAAS,GAAG,CAAC,EAAE,CAW9F;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAW5D;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,WAEjD"}

package/dist/src/utils.js

@@ -0,0 +1,35 @@
+/**
+ * Maps an array, skipping the value if `fn` returns `undefined`.
+ *
+ * @example mapMaybe(array, fn) ≡ array.map(fn).filter(v => v !== undefined)
+ */
+export function mapMaybe(array, fn) {
+    const result = [];
+    for (let i = 0; i < array.length; i++) {
+        const value = fn(array[i], i);
+        if (value !== undefined) {
+            result.push(value);
+        }
+    }
+    return result;
+}
+/**
+ * Insert a separator between each element of the array.
+ *
+ * @example intersperse(',', ['a', 'b', 'c']) ≡ ['a', ',', 'b', ',' 'c']
+ */
+export function intersperse(separator, array) {
+    if (array.length === 0)
+        return [];
+    const result = new Array(array.length * 2 - 1);
+    for (let i = 0; i < array.length - 1; i++) {
+        result[i * 2] = array[i];
+        result[i * 2 + 1] = separator;
+    }
+    result[result.length - 1] = array[array.length - 1];
+    return result;
+}
+export function isWhitespace(node) {
+    return typeof node === 'string' && node.trim().length === 0;
+}
+//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAO,KAAU,EAAE,EAA8C;IACvF,MAAM,MAAM,GAAQ,EAAE,CAAA;IAEtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC7B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACpB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAI,SAAY,EAAE,KAAU;IACrD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IACjC,MAAM,MAAM,GAAG,IAAI,KAAK,CAAI,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;IAEjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;QACxB,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAA;IAC/B,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACnD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAqB;IAChD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAA;AAC7D,CAAC"}

package/dist/src/validateAnswers.d.ts

@@ -0,0 +1,16 @@
+import { RootElement } from './parser/parseExamStructure';
+import { ExamAnswer, QuestionId } from './types/ExamAnswer';
+import { AnsweringInstructionProps } from './components/AnsweringInstructions';
+export type ValidationError = ExtraAnswer | AnswerTooLong;
+export interface AnswerTooLong {
+    type: 'AnswerTooLong';
+    displayNumber: string;
+    characterCount: number;
+    elementType: 'exam' | 'section' | 'question';
+}
+export interface ExtraAnswer extends AnsweringInstructionProps {
+    type: 'ExtraAnswer';
+    displayNumber: string;
+}
+export declare function validateAnswers(examStructure: RootElement, answersById: Record<QuestionId, ExamAnswer>): ValidationError[];
+//# sourceMappingURL=validateAnswers.d.ts.map

package/dist/src/validateAnswers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateAnswers.d.ts","sourceRoot":"","sources":["../../src/validateAnswers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,WAAW,EAAE,MAAM,6BAA6B,CAAA;AACtE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAE3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAA;AAE9E,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,aAAa,CAAA;AAEzD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,eAAe,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,CAAA;CAC7C;AAED,MAAM,WAAW,WAAY,SAAQ,yBAAyB;IAC5D,IAAI,EAAE,aAAa,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;CACtB;AA2GD,wBAAgB,eAAe,CAC7B,aAAa,EAAE,WAAW,EAC1B,WAAW,EAAE,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,GAC1C,eAAe,EAAE,CAInB"}

package/dist/src/validateAnswers.js

@@ -0,0 +1,89 @@
+import * as _ from 'lodash-es';
+function reduceExam(examStructure, reducer, initialValue) {
+    function go(accumulator, element) {
+        return element.childNodes.reduce(go, reducer(accumulator, element));
+    }
+    return go(initialValue, examStructure);
+}
+function validateAnswerLength(examStructure, answersById) {
+    return reduceExam(examStructure, (errors, element) => {
+        if (element.name === 'text-answer' && element.attributes.maxLength != null) {
+            const maybeAnswer = answersById[element.attributes.questionId];
+            if ((maybeAnswer === null || maybeAnswer === void 0 ? void 0 : maybeAnswer.type) === 'richText' || (maybeAnswer === null || maybeAnswer === void 0 ? void 0 : maybeAnswer.type) === 'text') {
+                return maybeAnswer.characterCount > element.attributes.maxLength
+                    ? [
+                        ...errors,
+                        {
+                            type: 'AnswerTooLong',
+                            displayNumber: element.attributes.displayNumber,
+                            characterCount: maybeAnswer.characterCount,
+                            elementType: 'question'
+                        }
+                    ]
+                    : errors;
+            }
+            return errors;
+        }
+        else {
+            return errors;
+        }
+    }, []);
+}
+function validateExtraAnswers(examStructure, answersById) {
+    // A recursive function that that calculates the answer count at each level
+    // (answerCount) and carries around an array of extra answers
+    function go(element) {
+        var _a;
+        const displayNumber = element.name === 'exam' ? '' : element.attributes.displayNumber;
+        switch (element.name) {
+            case 'exam':
+            case 'section':
+            case 'question': {
+                const children = element.childNodes.map(go);
+                const childrenWithAnswers = children.filter(v => v.answerCount > 0);
+                const maxAnswers = (_a = element.attributes.maxAnswers) !== null && _a !== void 0 ? _a : Infinity;
+                // Currently, min-answers exists only at section level.
+                const minAnswers = element.name === 'section' ? element.attributes.minAnswers : undefined;
+                // At exam level, answer count is the sum of answer counts of each
+                // section. At section and question levels, answer count is the number
+                // of child questions that have _any_ answers.
+                const answerCount = element.name === 'exam'
+                    ? childrenWithAnswers.reduce((acc, section) => acc + section.answerCount, 0)
+                    : childrenWithAnswers.length;
+                const childExtraAnswers = _.flatMap(children, v => v.extraAnswers);
+                // If there are extra answers on the current level, we prepend them to
+                // the extra answers array, so it is ordered naturally in document
+                // order.
+                const extraAnswers = answerCount > maxAnswers
+                    ? [
+                        {
+                            type: 'ExtraAnswer',
+                            elementType: element.name,
+                            displayNumber,
+                            childQuestions: children.map(v => v.displayNumber),
+                            maxAnswers,
+                            minAnswers
+                        },
+                        ...childExtraAnswers
+                    ]
+                    : childExtraAnswers;
+                return { answerCount, displayNumber, extraAnswers };
+            }
+            case 'text-answer':
+            case 'scored-text-answer':
+            case 'choice-answer':
+            case 'dropdown-answer': {
+                const maybeAnswer = answersById[element.attributes.questionId];
+                // An answer whose value is '' is considered to be empty, so we ignore
+                // them.
+                const isValidAnswer = (maybeAnswer === null || maybeAnswer === void 0 ? void 0 : maybeAnswer.value.length) > 0;
+                return { answerCount: isValidAnswer ? 1 : 0, displayNumber, extraAnswers: [] };
+            }
+        }
+    }
+    return go(examStructure).extraAnswers;
+}
+export function validateAnswers(examStructure, answersById) {
+    return _.flatMap([validateAnswerLength, validateExtraAnswers], validationFn => validationFn(examStructure, answersById));
+}
+//# sourceMappingURL=validateAnswers.js.map

package/dist/src/validateAnswers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateAnswers.js","sourceRoot":"","sources":["../../src/validateAnswers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,WAAW,CAAA;AAiB9B,SAAS,UAAU,CACjB,aAA0B,EAC1B,OAAoD,EACpD,YAAe;IAEf,SAAS,EAAE,CAAC,WAAc,EAAE,OAAoB;QAC9C,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAA;IACrE,CAAC;IAED,OAAO,EAAE,CAAC,YAAY,EAAE,aAAa,CAAC,CAAA;AACxC,CAAC;AAED,SAAS,oBAAoB,CAC3B,aAA0B,EAC1B,WAA2C;IAE3C,OAAO,UAAU,CACf,aAAa,EACb,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;QAClB,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC3E,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;YAC9D,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,MAAK,UAAU,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,MAAK,MAAM,EAAE,CAAC;gBACrE,OAAO,WAAW,CAAC,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS;oBAC9D,CAAC,CAAC;wBACE,GAAG,MAAM;wBACT;4BACE,IAAI,EAAE,eAAe;4BACrB,aAAa,EAAE,OAAO,CAAC,UAAU,CAAC,aAAa;4BAC/C,cAAc,EAAE,WAAW,CAAC,cAAc;4BAC1C,WAAW,EAAE,UAAU;yBACxB;qBACF;oBACH,CAAC,CAAC,MAAM,CAAA;YACZ,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,CAAA;QACf,CAAC;IACH,CAAC,EACD,EAAuB,CACxB,CAAA;AACH,CAAC;AAED,SAAS,oBAAoB,CAC3B,aAA0B,EAC1B,WAA2C;IAE3C,2EAA2E;IAC3E,6DAA6D;IAC7D,SAAS,EAAE,CAAC,OAAoB;;QAC9B,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAA;QAErF,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,MAAM,CAAC;YACZ,KAAK,SAAS,CAAC;YACf,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;gBAC3C,MAAM,mBAAmB,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,CAAA;gBACnE,MAAM,UAAU,GAAG,MAAA,OAAO,CAAC,UAAU,CAAC,UAAU,mCAAI,QAAQ,CAAA;gBAC5D,uDAAuD;gBACvD,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAA;gBACzF,kEAAkE;gBAClE,sEAAsE;gBACtE,8CAA8C;gBAC9C,MAAM,WAAW,GACf,OAAO,CAAC,IAAI,KAAK,MAAM;oBACrB,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;oBAC5E,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAA;gBAChC,MAAM,iBAAiB,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;gBAClE,sEAAsE;gBACtE,kEAAkE;gBAClE,SAAS;gBACT,MAAM,YAAY,GAChB,WAAW,GAAG,UAAU;oBACtB,CAAC,CAAC;wBACE;4BACE,IAAI,EAAE,aAAa;4BACnB,WAAW,EAAE,OAAO,CAAC,IAAI;4BACzB,aAAa;4BACb,cAAc,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC;4BAClD,UAAU;4BACV,UAAU;yBACI;wBAChB,GAAG,iBAAiB;qBACrB;oBACH,CAAC,CAAC,iBAAiB,CAAA;gBAEvB,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,YAAY,EAAE,CAAA;YACrD,CAAC;YACD,KAAK,aAAa,CAAC;YACnB,KAAK,oBAAoB,CAAC;YAC1B,KAAK,eAAe,CAAC;YACrB,KAAK,iBAAiB,CAAC,CAAC,CAAC;gBACvB,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;gBAC9D,sEAAsE;gBACtE,QAAQ;gBACR,MAAM,aAAa,GAAG,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,CAAC,MAAM,IAAG,CAAC,CAAA;gBACnD,OAAO,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,YAAY,EAAE,EAAE,EAAE,CAAA;YAChF,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,EAAE,CAAC,aAAa,CAAC,CAAC,YAAY,CAAA;AACvC,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,aAA0B,EAC1B,WAA2C;IAE3C,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,EAAE,YAAY,CAAC,EAAE,CAC5E,YAAY,CAAC,aAAa,EAAE,WAAW,CAAC,CACzC,CAAA;AACH,CAAC"}