commons-assessment 12.0.33 → 12.0.35

package/README.md

@@ -15,6 +15,8 @@ The library uses Bootstrap styles and requires the following modules to be impor
 - `AssessmentMakerModule` (If creating assessments)
 - `AssessmentTakerModule` (If rendering assessments)
 
+**Proctoring (optional):** if you use the proctoring feature, install the `@proctorlink/sdk` peer dependency (`npm install @proctorlink/sdk`) — it is loaded on demand only when a proctored session starts. Also allow the proctoring enclave in your app's `Content-Security-Policy`: `frame-src https://app-dev.proctorlink.com;`.
+
 ## Installation & Configuration
 
 ### 1. Import Modules
@@ -160,10 +162,13 @@ export class Component {
 | `[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. |
 | `(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.
@@ -212,6 +217,8 @@ To render the assessment taker interface, use the `<lib-assessment-taker>` compo
 | `[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. |
 | `(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. |
+| `(proctoringConsent)` | `@Output` | `EventEmitter<boolean>` | When the assessment is proctored, a mandatory, non-dismissable consent dialog is shown before the session starts. On consent the button shows a loader while the proctoring session is created/refreshed and the dialog stays open until the API responds. Emits `true` once the candidate consents and the session begins. |
+| `(proctoringSession)` | `@Output` | `EventEmitter<ProctoringSession>` | Emits the proctoring session issued on consent. |
 | `(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. |