@planning-inspectorate/dynamic-forms 1.7.0 → 1.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/dynamic-forms",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "description": "This package is for building GDS forms using a configuration-based approach.",
   "main": "./src/index.js",
   "type": "module",

package/src/components/multi-field-input/index.njk

@@ -60,11 +60,13 @@
                             errorMessage: errors[inputField.fieldName] and {
                                 text: errors[inputField.fieldName].msg
                             },
+                            prefix: inputField.prefix,
+                            suffix: inputField.suffix,
                             value: inputField.value,
                             hint: {
                                 text: inputField.hint
                             },
-                            classes: "govuk-input-!-width-three-quarters",
+                            classes: inputField.classes or "govuk-input-!-width-three-quarters",
                             attributes: inputField.attributes
                         }) }}
                     {% endfor %}

package/src/components/multi-field-input/question.js

@@ -10,6 +10,12 @@ import { nl2br } from '../../lib/utils.js';
  * @typedef {import('../../validator/base-validator')} BaseValidator
  */
 
+/**
+ * @typedef {Object} Suffix
+ * @property {string} text
+ * @property {string} [classes] optional property, used to add classes to the suffix/prefix
+ */
+
 /**
  * @typedef {Object} InputField
  * @property {string} fieldName
@@ -18,6 +24,8 @@ import { nl2br } from '../../lib/utils.js';
  * @property {string} [formatPrefix] optional property, used by formatAnswerForSummary (eg task list display), to prefix answer
  * @property {function} [formatTextFunction] optional property, used to format the answer for display and value in question
  * @property {Record<string, string>} [attributes] optional property, used to add html attributes to the field
+ * @property {Suffix} [suffix] optional property, used to add a suffix to the field
+ * @property {Suffix} [prefix] optional property, used to add a prefix to the field
  */
 
 /**

package/src/components/text-entry-redact/index.njk

@@ -1,12 +1,12 @@
 {% extends layoutTemplate %}
 
-{% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
-{% from "govuk/components/textarea/macro.njk" import govukTextarea %}
-{% from "govuk/components/label/macro.njk" import govukLabel %}
 {% from "govuk/components/button/macro.njk" import govukButton %}
 {% from "govuk/components/checkboxes/macro.njk" import govukCheckboxes %}
-{% from "govuk/components/inset-text/macro.njk" import govukInsetText %}
+{% from "govuk/components/details/macro.njk" import govukDetails %}
+{% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
+{% from "govuk/components/label/macro.njk" import govukLabel %}
 {% from "govuk/components/table/macro.njk" import govukTable %}
+{% from "govuk/components/textarea/macro.njk" import govukTextarea %}
 
 {% block before_content %}
     <div class="govuk-grid-row">
@@ -24,14 +24,9 @@
     {{ super() }}
 {% endblock before_content %}
 
-{% set columnWidth = 'govuk-grid-column-two-thirds' %}
-{% if showSuggestionsUi %}
-    {% set columnWidth = 'govuk-grid-column-one-half' %}
-{% endif %}
-
 {% block content %}
     <div class="govuk-grid-row">
-        <div class="{{ columnWidth }}">
+        <div class="govuk-grid-column-two-thirds">
             <form action="" method="post" novalidate>
                 <input type="hidden" name="_csrf" value="{{ _csrf }}">
 
@@ -53,15 +48,59 @@
                     {% include question.html ignore missing %}
                 {% endif %}
 
-                <label class="govuk-label govuk-label--s govuk-!-margin-top-5" for="{{ question.fieldName }}-unredacted">
-                    Original
-                    <a href="#" class="govuk-link govuk-!-margin-left-2" id="toggle-original">Hide</a>
-                </label>
+                {% if showSuggestionsUi %}
+                    <h2 class="govuk-heading-m">Redaction suggestions</h2>
+                    {% set hasSuggestions = redactionSuggestions.length > 0 %}
+                    {% if hasSuggestions %}
+                        <p class="govuk-body">
+                            We have suggested some common redactions and hidden these for you.
+                            To make these visible again, 'Reject' each suggestion.
+                        </p>
+                        {% set suggestionTableRows = [] %}
+                        {% for s in redactionSuggestions  %}
+                            {% set category = s.category %}
+                            {% if s.subCategory %}
+                                {% set category = category + " (" +  s.subCategory + ")" %}
+                            {% endif %}
+                            {% set action = 'Accept' %}
+                            {% if s.accepted %}
+                                {% set action = 'Reject' %}
+                            {% endif %}
+                            {% set suggestionTableRows = (suggestionTableRows.push([
+                                {text: s.text},
+                                {text: category },
+                                {
+                                    html: '<a href="#" class="govuk-link" data-redact="suggestion-reject-' + loop.index0 + '">' + action + '</a>'
+                                }
+                            ]), suggestionTableRows) %}
+                        {% endfor %}
+                        {{  govukTable({
+                            head: [
+                                {
+                                    text: "Redaction suggestion"
+                                },
+                                {
+                                    text: "Type of information"
+                                },
+                                {
+                                    text: "Action"
+                                }
+                            ],
+                            rows: suggestionTableRows
+                        }) }}
+                    {% else %}
+                        <p class="govuk-body">
+                            No redaction suggestions found.
+                        </p>
+                    {% endif %}
+                {% endif %}
 
-                {{ govukInsetText({
+                <h2 class="govuk-heading-m">Redaction preview</h2>
+
+                {{ govukDetails({
+                    summaryText: question.summaryText or "Original",
                     html: question.value,
-                    id: question.fieldName + "-unredacted",
-                    classes: "govuk-!-margin-top-0"
+                    id: question.fieldName + "-unredacted"
                 }) }}
 
                 {{ govukTextarea({
@@ -75,7 +114,11 @@
                     errorMessage: errors[question.fieldName] and {
                         text: errors[question.fieldName].msg
                     },
-                    classes: question.inputClasses
+                    classes: question.inputClasses,
+                    attributes: {
+                        readonly: true
+                    },
+                    rows: textAreaRows or 8
                 }) }}
 
                 <div class="govuk-button-group">
@@ -108,48 +151,6 @@
                 }) }}
             </form>
         </div>
-        {% if showSuggestionsUi %}
-            <div class="govuk-grid-column-one-half">
-                <h2 class="govuk-heading-m">Redaction suggestions</h2>
-                <p class="govuk-body">
-                    This section includes system suggestions for redactions.
-                    Each row shows the text that is suggested for redaction and the category detected.
-                    They are all redacted by default, you can reject any that should not be redacted by clicking the "Reject" link next to each suggestion.
-                </p>
-                {% set suggestionTableRows = [] %}
-                {% for s in redactionSuggestions  %}
-                    {% set category = s.category %}
-                    {% if s.subCategory %}
-                        {% set category = category + " (" +  s.subCategory + ")" %}
-                    {% endif %}
-                    {% set action = 'Accept' %}
-                    {% if s.accepted %}
-                        {% set action = 'Reject' %}
-                    {% endif %}
-                    {% set suggestionTableRows = (suggestionTableRows.push([
-                        {text: s.text},
-                        {text: category },
-                        {
-                            html: '<a href="#" class="govuk-link" data-redact="suggestion-reject-' + loop.index0 + '">' + action + '</a>'
-                        }
-                    ]), suggestionTableRows) %}
-                {% endfor %}
-                {{  govukTable({
-                    head: [
-                        {
-                            text: "Text"
-                        },
-                        {
-                            text: "Category"
-                        },
-                        {
-                            text: "Action"
-                        }
-                    ],
-                    rows: suggestionTableRows
-                }) }}
-            </div>
-        {% endif %}
 
         <script {% if cspNonce %}nonce={{ cspNonce }}{% endif %}>
           /**

package/src/components/text-entry-redact/question.js

@@ -27,8 +27,18 @@ export default class TextEntryRedactQuestion extends Question {
 	 * @param {string|undefined} [params.label] if defined this show as a label for the input and the question will just be a standard h1
 	 * @param {boolean} [params.onlyShowRedactedValueForSummary] whether to only show redacted value for summary
 	 * @param {boolean} [params.useRedactedFieldNameForSave] whether to use the redacted field name when saving answers
+	 * @param {boolean} [params.showSuggestionsUi] use the suggestions UI for this question
+	 * @param {string} [params.summaryText] summaryText to use with the details component
 	 */
-	constructor({ textEntryCheckbox, label, onlyShowRedactedValueForSummary, useRedactedFieldNameForSave, ...params }) {
+	constructor({
+		textEntryCheckbox,
+		label,
+		onlyShowRedactedValueForSummary,
+		useRedactedFieldNameForSave,
+		showSuggestionsUi,
+		summaryText,
+		...params
+	}) {
 		super({
 			...params,
 			viewFolder: 'text-entry-redact'
@@ -38,6 +48,8 @@ export default class TextEntryRedactQuestion extends Question {
 		this.label = label;
 		this.onlyShowRedactedValueForSummary = onlyShowRedactedValueForSummary;
 		this.useRedactedFieldNameForSave = useRedactedFieldNameForSave;
+		this.showSuggestionsUi = showSuggestionsUi;
+		this.summaryText = summaryText;
 	}
 
 	async getDataToSave(req, journeyResponse) {
@@ -58,6 +70,8 @@ export default class TextEntryRedactQuestion extends Question {
 		viewModel.question.value = payload ? payload[viewModel.question.fieldName] : viewModel.question.value;
 		viewModel.question.valueRedacted =
 			journey.response.answers[this.fieldName + 'Redacted'] || viewModel.question.value;
+		viewModel.question.summaryText = this.summaryText;
+		viewModel.showSuggestionsUi = this.showSuggestionsUi;
 		return viewModel;
 	}
 

package/src/components/text-entry-redact/question.test.js

@@ -12,7 +12,7 @@ describe('./src/dynamic-forms/components/text-entry-redact/question.js', () => {
 	const HINT = 'hint';
 	const LABEL = 'A label';
 
-	function createQuestion() {
+	function createQuestion(showSuggestionsUi = false) {
 		return new TextEntryRedactQuestion({
 			title: TITLE,
 			question: QUESTION,
@@ -20,7 +20,8 @@ describe('./src/dynamic-forms/components/text-entry-redact/question.js', () => {
 			validators: VALIDATORS,
 			html: HTML,
 			hint: HINT,
-			label: LABEL
+			label: LABEL,
+			showSuggestionsUi
 		});
 	}
 	it('should create', () => {
@@ -72,11 +73,10 @@ describe('./src/dynamic-forms/components/text-entry-redact/question.js', () => {
 		const view = mockRes.render.mock.calls[0].result;
 		assert.ok(view);
 		assert.match(view, /Redaction Question/);
-		assert.match(view, /govuk-grid-column-two-thirds">\s+<form/);
 		assert.doesNotMatch(view, /Redaction suggestions/);
 	});
 	it('should render suggestions view', () => {
-		const question = createQuestion();
+		const question = createQuestion(true);
 		const section = {
 			name: 'section-name'
 		};
@@ -94,7 +94,6 @@ describe('./src/dynamic-forms/components/text-entry-redact/question.js', () => {
 			}
 		};
 		const customViewData = {
-			showSuggestionsUi: true,
 			layoutTemplate: 'lib/test-layout.njk',
 			question: {
 				question: 'Redaction Question',
@@ -113,8 +112,51 @@ describe('./src/dynamic-forms/components/text-entry-redact/question.js', () => {
 		const view = mockRes.render.mock.calls[0].result;
 		assert.ok(view);
 		assert.match(view, /Redaction Question/);
-		assert.match(view, /govuk-grid-column-one-half">\s+<form/);
-		assert.doesNotMatch(view, /govuk-grid-column-two-thirds">\s+<form/);
 		assert.match(view, /Redaction suggestions/);
+		assert.match(view, /No redaction suggestions found\./);
+	});
+	it('should render suggestions view with data', () => {
+		const question = createQuestion(true);
+		const section = {
+			name: 'section-name'
+		};
+		const journey = {
+			baseUrl: '',
+			taskListUrl: 'task',
+			journeyTemplate: 'template',
+			journeyTitle: 'title',
+			journeyId: 'manage-representations',
+			getBackLink: () => {
+				return 'back';
+			},
+			response: {
+				answers: {}
+			}
+		};
+		const customViewData = {
+			layoutTemplate: 'lib/test-layout.njk',
+			question: {
+				question: 'Redaction Question',
+				fieldName: 'field-name',
+				value: 'value',
+				valueRedacted: 'value-redacted'
+			},
+			redactionSuggestions: [
+				{ category: 'Person', suggestion: 'Test Person' },
+				{ category: 'Address', suggestion: '123 Fake Street' }
+			]
+		};
+		const nunjucks = configureNunjucks();
+		const mockRes = {
+			render: mock.fn((view, data) => nunjucks.render(view + '.njk', data))
+		};
+		const viewModel = question.prepQuestionForRendering(section, journey, customViewData);
+		question.renderAction(mockRes, viewModel);
+		assert.strictEqual(mockRes.render.mock.callCount(), 1);
+		const view = mockRes.render.mock.calls[0].result;
+		assert.ok(view);
+		assert.match(view, /Redaction Question/);
+		assert.match(view, /Redaction suggestions/);
+		assert.match(view, /We have suggested some common redactions/);
 	});
 });

package/src/validator/date-time-validator.js

@@ -14,9 +14,19 @@ export default class DateTimeValidator extends DateValidator {
 	 * creates an instance of a DateTimeValidator
 	 * @param {string} timeInputLabel - string representing the time fields as displayed on the UI as part of an error message
 	 * @param {string} [dateInputLabel] - string representing the date fields as displayed on the UI as part of an error message
+	 * @param {DateValidationSettings} [dateValidationSettings] - object containing rules to apply
+	 * @param {Object} [dateErrorMessages] - object containing custom date error messages to show on validation failure
 	 */
-	constructor(timeInputLabel, dateInputLabel = timeInputLabel) {
-		super(dateInputLabel);
+	constructor(
+		timeInputLabel,
+		dateInputLabel = timeInputLabel,
+		dateValidationSettings = {
+			ensureFuture: false,
+			ensurePast: false
+		},
+		dateErrorMessages
+	) {
+		super(dateInputLabel, dateValidationSettings, dateErrorMessages);
 		this.timeInputLabel = timeInputLabel;
 	}
 

package/src/validator/date-time-validator.test.js

@@ -253,10 +253,35 @@ describe('./lib/forms/custom-components/date-time/date-time-validator.js', () =>
 		assert.strictEqual(errors[`${question.fieldName}_day`].msg, 'Enter Site visit');
 		assert.strictEqual(errors[`${question.fieldName}_hour`].msg, 'Enter the site visit time');
 	});
+	it('dateErrorMessages overrides errors returned by date validator', async () => {
+		const req = {
+			body: {
+				['date-time-question_day']: undefined,
+				['date-time-question_month']: undefined,
+				['date-time-question_year']: undefined,
+				['date-time-question_hour']: undefined,
+				['date-time-question_minutes']: undefined,
+				['date-time-question_period']: ''
+			}
+		};
+
+		const errors = await _validationMappedErrors(req, question, 'Site visit', 'site visit date', {
+			emptyErrorMessage: 'Site visit date error override'
+		});
+
+		assert.strictEqual(Object.keys(errors).length, 6);
+		assert.strictEqual(errors[`${question.fieldName}_day`].msg, 'Site visit date error override');
+		assert.strictEqual(errors[`${question.fieldName}_hour`].msg, 'Enter the site visit time');
+	});
 });
 
-const _validationMappedErrors = async (req, question, inputLabel, dateInputLabel) => {
-	const dateTimeValidator = new DateTimeValidator(inputLabel, dateInputLabel);
+const _validationMappedErrors = async (req, question, inputLabel, dateInputLabel, dateErrorMessages) => {
+	const dateTimeValidator = new DateTimeValidator(
+		inputLabel,
+		dateInputLabel,
+		{ ensureFuture: false, ensurePast: false },
+		dateErrorMessages
+	);
 
 	const validationRules = dateTimeValidator.validate(question);