commons-assessment 12.1.0 → 12.1.1

package/README.md

@@ -25,6 +25,8 @@ Import the following modules in your application:
 - `AssessmentMakerModule` (If creating assessments)
 - `AssessmentTakerModule` (If rendering assessments)
 
+**Proctoring (optional):** the library does **not** import `@proctorlink/sdk` directly, so apps that don't use proctoring need not install it and build cleanly. If you use proctoring, install it (`npm install @proctorlink/sdk`) and pass a loader to the taker via `[proctorLinkLoader]="() => import('@proctorlink/sdk')"` — the SDK is then fetched on demand only when a proctored session starts, and the module reference stays in your app's bundle. Also allow the proctoring enclave in your app's `Content-Security-Policy`: `frame-src https://app-dev.proctorlink.com;`.
+
 ## Installation & Configuration
 
 ### 1. Import Modules
@@ -169,10 +171,15 @@ export class Component {
 | `[predefinedAssessmentInstance]` | `@Input` | `AssessmentInstance` | The default contextual configuration object for creating new assessment instances. |
 | `[minimumRequiredSections]` | `@Input` | `number` | Minimum number of sections needed before assessment can be published. Default is 0. |
 | `[assessmentContext]` | `@Input` | `AssessmentContext` | (Optional) Pre-loaded assessment context data to bypass the initial data load API call. |
+| `[checkForResponses]` | `@Input` | `boolean` | If true, show a warning on deletion of sections and questions if any responses are linked to them. Default is false. |
+| `[showProctoringToggle]` | `@Input` | `boolean` | (Optional) If true, shows a toggle to enable/disable proctoring. Default is false. Works only when partial response submission is allowed. |
+| `[showTimeInput]` | `@Input` | `boolean` | (Optional) If true, shows an optional duration (minutes) input. The value is saved (in seconds) to the assessment instance's `duration` — bundled into the patch API when the instance exists, or set on the created instance otherwise. Leave it empty for an untimed assessment. Default is false. |
 | `(assessmentIdChange)` | `@Output` | `EventEmitter<number>` | Emits the new `assessmentId` when an assessment is successfully created. |
 | `(assessmentInstanceIdChange)` | `@Output` | `EventEmitter<number>` | Emits the new instance ID integer when an assessment is published. |
 | `(snackbarMessage)` | `@Output` | `EventEmitter<{ message: string, type: 'success' \| 'error' \| 'info' }>` | Emits message status updates representing errors and workflow successes from the service. |
 
+> **Assessment configuration (e.g. allowing partial responses):** behavioral flags such as allowing partial responses are set via `assessmentConfigs` on the assessment DTO. See [Assessment Configuration](../../documentation/assessment-maker.md#assessment-configuration-assessmentconfigs) in the maker documentation for the available config keys and examples.
+
 ### Assessment Taker
 
 To render the assessment taker interface, use the `<lib-assessment-taker>` component in your template.
@@ -220,7 +227,11 @@ To render the assessment taker interface, use the `<lib-assessment-taker>` compo
 | `[showOverallRemarks]` | `@Input` | `boolean` | (Optional) Shows overall remarks field. Default is false. |
 | `[showCorrectAnswers]` | `@Input` | `boolean` | (Optional) Shows correct and incorrect answers for objective and multiselect type questions. Default is false. |
 | `[enableSkillsToQuestionMapping]` | `@Input` | `boolean` | (Optional) Enables ability to map skills to questions. Default is false. |
+| `[proctorLinkLoader]` | `@Input` | `() => Promise<any>` | (Optional) Loader for the optional `@proctorlink/sdk`, e.g. `() => import('@proctorlink/sdk')`. Required only when proctoring is enabled; keeps the SDK out of the library bundle so non-proctoring apps don't need the package installed. |
+| `[resumeTimerAcrossVisits]` | `@Input` | `boolean` | (Optional) For timed assessments, anchors the countdown to the assessee's first-visit time (`assesseeResponse.createdAt`) so it keeps elapsing across reloads/absences instead of restarting each visit. On begin, the assessee is created up front (already created when proctoring is enabled) so `createdAt` exists. On return, remaining time = `duration - elapsedSinceCreatedAt`; if it has already elapsed, the timer shows `00:00` and the assessment auto-submits. Default is false. |
+| `[warnOnLeaveDuringProctoring]` | `@Input` | `boolean` | (Optional) While a proctoring session is running, warn the candidate before they refresh/close/navigate away (the browser's native "Leave site?" prompt) or press the in-app Back button (a custom confirmation dialog). Set `false` to disable both warnings. Default is true. |
 | `(stepChanged)` | `@Output` | `EventEmitter<{ currentStepIndex: number, totalSteps: number, isLastStep: boolean }>` | Emits initially and on every step change. Provides the current step index, total steps, and indicating boolean. |
+| `(consentToProceed)` | `@Output` | `EventEmitter<boolean>` | A full-screen intro gate is shown before the assessment starts when proctoring is enabled, or when `[resumeTimerAcrossVisits]` is set on a timed assessment. It presents the assessment details/warnings (and, for proctoring, the consent notice + reference-photo capture). On proceed, the assessee is created (and the proctoring session started, when proctored) with a loader; emits `true` once the candidate agrees and the assessment begins. |
 | `(submitAssessment)` | `@Output` | `EventEmitter<{ assesseeId: number, completed: boolean }>` | Emits when the assessment is submitted, containing the `assesseeId` and a `completed` flag indicating if the taker finished the entire assessment. |
 | `(snackbarMessage)` | `@Output` | `EventEmitter<{ message: string, type: 'success' \| 'error' \| 'info' }>` | Emits message status updates representing errors and workflow successes from the service. |