@planning-inspectorate/dynamic-forms 1.10.0 → 1.11.0

package/package.json

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

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

@@ -1,4 +1,5 @@
 import { Question } from '../../questions/question.js';
+import { nl2br } from '../../lib/utils.js';
 
 /**
  * @typedef {import('../../questions/question.js').QuestionViewModel} QuestionViewModel
@@ -16,6 +17,7 @@ import { Question } from '../../questions/question.js';
  */
 
 export const REDACT_CHARACTER = '█';
+export const TRUNCATED_MAX_LENGTH = 500;
 
 /**
  * @class
@@ -29,6 +31,7 @@ export default class TextEntryRedactQuestion extends Question {
 	 * @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
+	 * @param {boolean} [params.shouldTruncateSummary] determines whether redacted comment is truncated in summary view
 	 */
 	constructor({
 		textEntryCheckbox,
@@ -37,6 +40,7 @@ export default class TextEntryRedactQuestion extends Question {
 		useRedactedFieldNameForSave,
 		showSuggestionsUi,
 		summaryText,
+		shouldTruncateSummary,
 		...params
 	}) {
 		super({
@@ -50,6 +54,7 @@ export default class TextEntryRedactQuestion extends Question {
 		this.useRedactedFieldNameForSave = useRedactedFieldNameForSave;
 		this.showSuggestionsUi = showSuggestionsUi;
 		this.summaryText = summaryText;
+		this.shouldTruncateSummary = shouldTruncateSummary;
 	}
 
 	async getDataToSave(req, journeyResponse) {
@@ -83,6 +88,20 @@ export default class TextEntryRedactQuestion extends Question {
 		} else {
 			toShow = redacted || answer;
 		}
+
+		if (this.shouldTruncateSummary && toShow?.length > TRUNCATED_MAX_LENGTH) {
+			const action = this.getAction(sectionSegment, journey, answer);
+			const truncatedToShow = toShow.substring(0, TRUNCATED_MAX_LENGTH);
+			toShow = `${truncatedToShow}... <a class="govuk-link govuk-link--no-visited-state" href="${action?.href}">Read more</a>`;
+			return [
+				{
+					key: this.title ?? this.question,
+					value: nl2br(toShow),
+					action
+				}
+			];
+		}
+
 		return super.formatAnswerForSummary(sectionSegment, journey, toShow, capitals);
 	}
 }

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

@@ -159,4 +159,113 @@ describe('./src/dynamic-forms/components/text-entry-redact/question.js', () => {
 		assert.match(view, /Redaction suggestions/);
 		assert.match(view, /We have suggested some common redactions/);
 	});
+	it('should format answer for summary', () => {
+		const question = createQuestion();
+		const journey = {
+			baseUrl: '',
+			taskListUrl: 'task',
+			journeyTemplate: 'template',
+			journeyTitle: 'title',
+			journeyId: 'manage-representations',
+			getBackLink: () => {
+				return 'back';
+			},
+			getCurrentQuestionUrl: () => {
+				return '/redacted-comment';
+			},
+			response: {
+				answers: {}
+			}
+		};
+		const answer =
+			'It began with an ordinary morning. The air smelled faintly of dew, the street empty but for leaves drifting lazily. ████████ ██████ adjusted his collar, noting his watch was three minutes late—a stubborn old thing, loyal only to its own time. Across the street, a bakery opened, the scent of bread spilling into the cool air. A woman in a green scarf carried loaves in quiet balance. The square stirred slowly; ████████ wrote in his notebook, letting the day delay his errands, wholly unhurried and serene.';
+
+		const viewModel = question.formatAnswerForSummary('section', journey, answer);
+
+		assert.deepStrictEqual(viewModel, [
+			{
+				key: 'title',
+				value:
+					'It began with an ordinary morning. The air smelled faintly of dew, the street empty but for leaves drifting lazily. ████████ ██████ adjusted his collar, noting his watch was three minutes late—a stubborn old thing, loyal only to its own time. Across the street, a bakery opened, the scent of bread spilling into the cool air. A woman in a green scarf carried loaves in quiet balance. The square stirred slowly; ████████ wrote in his notebook, letting the day delay his errands, wholly unhurried and serene.',
+				action: {
+					href: '/redacted-comment',
+					text: 'Change',
+					visuallyHiddenText: 'Question?'
+				}
+			}
+		]);
+	});
+	it('should truncate when formating answer for summary when shouldTruncateSummary is true', () => {
+		const question = createQuestion();
+		question.shouldTruncateSummary = true;
+		const journey = {
+			baseUrl: '',
+			taskListUrl: 'task',
+			journeyTemplate: 'template',
+			journeyTitle: 'title',
+			journeyId: 'manage-representations',
+			getBackLink: () => {
+				return 'back';
+			},
+			getCurrentQuestionUrl: () => {
+				return '/redacted-comment';
+			},
+			response: {
+				answers: {}
+			}
+		};
+		const answer =
+			'It began with an ordinary morning. The air smelled faintly of dew, the street empty but for leaves drifting lazily. ████████ ██████ adjusted his collar, noting his watch was three minutes late—a stubborn old thing, loyal only to its own time. Across the street, a bakery opened, the scent of bread spilling into the cool air. A woman in a green scarf carried loaves in quiet balance. The square stirred slowly; ████████ wrote in his notebook, letting the day delay his errands, wholly unhurried and serene.';
+
+		const viewModel = question.formatAnswerForSummary('section', journey, answer);
+
+		assert.deepStrictEqual(viewModel, [
+			{
+				key: 'title',
+				value: `It began with an ordinary morning. The air smelled faintly of dew, the street empty but for leaves drifting lazily. ████████ ██████ adjusted his collar, noting his watch was three minutes late—a stubborn old thing, loyal only to its own time. Across the street, a bakery opened, the scent of bread spilling into the cool air. A woman in a green scarf carried loaves in quiet balance. The square stirred slowly; ████████ wrote in his notebook, letting the day delay his errands, wholly unhurried and s... <a class="govuk-link govuk-link--no-visited-state" href="/redacted-comment">Read more</a>`,
+				action: {
+					href: '/redacted-comment',
+					text: 'Change',
+					visuallyHiddenText: 'Question?'
+				}
+			}
+		]);
+	});
+	it('should not truncate when formating answer for summary when shouldTruncateSummary is true and length less than 500', () => {
+		const question = createQuestion();
+		question.shouldTruncateSummary = true;
+		const journey = {
+			baseUrl: '',
+			taskListUrl: 'task',
+			journeyTemplate: 'template',
+			journeyTitle: 'title',
+			journeyId: 'manage-representations',
+			getBackLink: () => {
+				return 'back';
+			},
+			getCurrentQuestionUrl: () => {
+				return '/redacted-comment';
+			},
+			response: {
+				answers: {}
+			}
+		};
+		const answer =
+			'It began, as many stories do, with an ordinary morning. The air carried the faint smell of dew, and the street was empty save for a few scattered leaves drifting lazily o████████ze too shy to commit to being wind. Jonathan Price adjusted his collar and glanced at his watch, noting with mild irritation tha███████████████████████████ree minutes late.';
+
+		const viewModel = question.formatAnswerForSummary('section', journey, answer);
+
+		assert.deepStrictEqual(viewModel, [
+			{
+				key: 'title',
+				value:
+					'It began, as many stories do, with an ordinary morning. The air carried the faint smell of dew, and the street was empty save for a few scattered leaves drifting lazily o████████ze too shy to commit to being wind. Jonathan Price adjusted his collar and glanced at his watch, noting with mild irritation tha███████████████████████████ree minutes late.',
+				action: {
+					href: '/redacted-comment',
+					text: 'Change',
+					visuallyHiddenText: 'Question?'
+				}
+			}
+		]);
+	});
 });