@planning-inspectorate/dynamic-forms 3.21.0 → 3.23.0

package/src/components/number-entry/question.test.js

@@ -14,4 +14,69 @@ describe('number-entry', () => {
 
 		assert.strictEqual(question.capitaliseAnswer, true);
 	});
+
+	it('should accept Affix objects for prefix and suffix', () => {
+		const PREFIX = { text: '£', classes: 'govuk-!-font-weight-bold' };
+		const SUFFIX = { text: 'kg' };
+
+		const question = new NumberEntryQuestion({
+			title: 'Question',
+			question: 'Question',
+			fieldName: 'question',
+			url: 'Question',
+			prefix: PREFIX,
+			suffix: SUFFIX
+		});
+
+		assert.strictEqual(question.prefix, PREFIX);
+		assert.strictEqual(question.suffix, SUFFIX);
+	});
+
+	it('should convert string suffix to Affix object and warn about deprecation', (t) => {
+		const warnMock = t.mock.method(console, 'warn', () => {});
+
+		const question = new NumberEntryQuestion({
+			title: 'Question',
+			question: 'Question',
+			fieldName: 'question',
+			url: 'Question',
+			suffix: 'kg'
+		});
+
+		assert.deepStrictEqual(question.suffix, { text: 'kg' });
+		assert.strictEqual(warnMock.mock.calls.length, 1);
+		assert.match(warnMock.mock.calls[0].arguments[0], /suffix.*deprecated/);
+	});
+
+	it('should leave prefix and suffix undefined when not provided', () => {
+		const question = new NumberEntryQuestion({
+			title: 'Question',
+			question: 'Question',
+			fieldName: 'question',
+			url: 'Question'
+		});
+
+		assert.strictEqual(question.prefix, undefined);
+		assert.strictEqual(question.suffix, undefined);
+	});
+
+	it('should add prefix and suffix to the view model', () => {
+		const PREFIX = { text: '£' };
+		const SUFFIX = { text: 'kg' };
+
+		const question = new NumberEntryQuestion({
+			title: 'Question',
+			question: 'Question',
+			fieldName: 'question',
+			url: 'Question',
+			prefix: PREFIX,
+			suffix: SUFFIX
+		});
+
+		const viewModel = { question: {} };
+		question.addCustomDataToViewModel(viewModel);
+
+		assert.strictEqual(viewModel.question.prefix, PREFIX);
+		assert.strictEqual(viewModel.question.suffix, SUFFIX);
+	});
 });

package/src/components/text-entry-redact/question.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAGA,+BAAgC,QAAG,CAAC;AACpC,mCAAoC,GAAG,CAAC;AAExC;;GAEG;AACH;IACC;;OAEG;IACH,gLAFW,OAAO,+BAA+B,EAAE,6BAA6B,EAwB/E;IAPA,yFAA0C;IAC1C,0BAAkB;IAClB,qDAAsE;IACtE,iDAA8D;IAC9D,uCAA0C;IAC1C,gCAA8B;IAC9B,2CAAkD;IAkBnD,+NAOC;IAED,yCAEC;IAYD;;OAEG;IACH,iJAuBC;CACD;;yBAtGwB,WAAW"}
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAGA,+BAAgC,QAAG,CAAC;AACpC,mCAAoC,GAAG,CAAC;AAExC;;GAEG;AACH;IACC;;OAEG;IACH,gLAFW,OAAO,+BAA+B,EAAE,6BAA6B,EAwB/E;IAPA,yFAA0C;IAC1C,0BAAkB;IAClB,qDAAsE;IACtE,iDAA8D;IAC9D,uCAA0C;IAC1C,gCAA8B;IAC9B,2CAAkD;IAkBnD,+NAOC;IAED,yCAEC;IAYD;;OAEG;IACH,iJAyBC;CACD;;yBAxGwB,WAAW"}

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

@@ -77,7 +77,9 @@ export class TextEntryRedactQuestion extends Question {
 	 * returns the formatted answers values to be used to build task list elements
 	 */
 	formatAnswerForSummary(sectionSegment, journey, answer, capitals = true) {
-		const redacted = journey.response.answers[this.fieldName + 'Redacted'];
+		// get the response/answers for the section we're in - which might be a dynamic section
+		const response = journey.responseForSection(sectionSegment);
+		const redacted = response.answers[this.fieldName + 'Redacted'];
 		let toShow;
 		if (this.onlyShowRedactedValueForSummary) {
 			toShow = redacted;

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

@@ -211,6 +211,9 @@ describe('./src/dynamic-forms/components/text-entry-redact/question.js', () => {
 			getCurrentQuestionUrl: () => {
 				return '/redacted-comment';
 			},
+			responseForSection() {
+				return this.response;
+			},
 			response: {
 				answers: {}
 			}
@@ -248,6 +251,9 @@ describe('./src/dynamic-forms/components/text-entry-redact/question.js', () => {
 			getCurrentQuestionUrl: () => {
 				return '/redacted-comment';
 			},
+			responseForSection() {
+				return this.response;
+			},
 			response: {
 				answers: {}
 			}
@@ -284,6 +290,9 @@ describe('./src/dynamic-forms/components/text-entry-redact/question.js', () => {
 			getCurrentQuestionUrl: () => {
 				return '/redacted-comment';
 			},
+			responseForSection() {
+				return this.response;
+			},
 			response: {
 				answers: {}
 			}

package/src/components/unit-option-entry/question.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH;IAIC;;;OAGG;IACH,uEAHW,OAAO,+BAA+B,EAAE,6BAA6B,oBACrE,MAAM,CAAC,MAAM,WAAW,EAoBlC;IAzBD,gCAAgC;IAChC,SADW,KAAK,CAAC,UAAU,CAAC,CACpB;IAoBP,6BAAgD;IAEhD,0BAAkB;IAClB,yBAA+C;IAGhD;;;;;;;;;;;;OAYG;IACH,kCAXW,OAAO,kBAAkB,EAAE,OAAO,WAClC,OAAO,UAAU,EAAE,OAAO,mBAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACvB,OAAO,+BAA+B,EAAE,+BAA+B,GACrE,OAAO,+BAA+B,EAAE,iBAAiB,GAAG;QACpE,QAAQ,EAAE,OAAO,+BAA+B,EAAE,iBAAiB,CAAC,UAAU,CAAC,GAAG;YAChF,OAAO,EAAC,UAAU,EAAE,CAAA;SACrB,CAAA;KACF,CAmDH;IAED;;;;;OAKG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,eAAe,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAgCzD;IAED;;OAEG;IACH,6HAaC;CACD;;;;;;;;;;yBArKY;IACR,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,WAAW,EAAE;QACX,SAAS,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAA;CACH;yBA5BsB,6BAA6B"}
+{"version":3,"file":"question.d.ts","sourceRoot":"","sources":["question.js"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH;IAIC;;;OAGG;IACH,uEAHW,OAAO,+BAA+B,EAAE,6BAA6B,oBACrE,MAAM,CAAC,MAAM,WAAW,EAoBlC;IAzBD,gCAAgC;IAChC,SADW,KAAK,CAAC,UAAU,CAAC,CACpB;IAoBP,6BAAgD;IAEhD,0BAAkB;IAClB,yBAA+C;IAGhD;;;;;;;;;;;;OAYG;IACH,kCAXW,OAAO,kBAAkB,EAAE,OAAO,WAClC,OAAO,UAAU,EAAE,OAAO,mBAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WACvB,OAAO,+BAA+B,EAAE,+BAA+B,GACrE,OAAO,+BAA+B,EAAE,iBAAiB,GAAG;QACpE,QAAQ,EAAE,OAAO,+BAA+B,EAAE,iBAAiB,CAAC,UAAU,CAAC,GAAG;YAChF,OAAO,EAAC,UAAU,EAAE,CAAA;SACrB,CAAA;KACF,CAmDH;IAED;;;;;OAKG,CACH,mBAJW,OAAO,SAAS,EAAE,OAAO,mBACzB,eAAe,GACb,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAgCzD;IAED;;OAEG;IACH,6HAeC;CACD;;;;;;;;;;yBAvKY;IACR,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,WAAW,EAAE;QACX,SAAS,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,OAAO,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAA;CACH;yBA5BsB,6BAA6B"}

package/src/components/unit-option-entry/question.js

@@ -169,7 +169,9 @@ export class UnitOptionEntryQuestion extends Question {
 		const selectedOption = this.options.find((option) => option.value === answer);
 		const conversionFactor =
 			(!conditionalIsJustHTML(selectedOption?.conditional) && selectedOption?.conditional.conversionFactor) || 1;
-		const unconvertedAnswer = journey.response.answers[this.conditionalFieldName];
+		// get the response/answers for the section we're in - which might be a dynamic section
+		const response = journey.responseForSection(sectionSegment);
+		const unconvertedAnswer = response.answers[this.conditionalFieldName];
 
 		const answerQuantity = Number(unconvertedAnswer) / conversionFactor;
 		if (isNaN(answerQuantity)) throw new Error('Conditional answer had an unexpected type');

package/src/components/unit-option-entry/question.test.js

@@ -75,6 +75,9 @@ describe('./src/dynamic-forms/components/unit-option-entry/question.js', () => {
 					[CONDITIONAL_FIELDNAME]: '1.123456789'
 				}
 			},
+			responseForSection() {
+				return this.response;
+			},
 			getCurrentQuestionUrl: mock.fn()
 		};
 		const result = unitOptionEntryQuestion.formatAnswerForSummary('test', journey, 'ha');
@@ -87,6 +90,9 @@ describe('./src/dynamic-forms/components/unit-option-entry/question.js', () => {
 					[CONDITIONAL_FIELDNAME]: '1'
 				}
 			},
+			responseForSection() {
+				return this.response;
+			},
 			getCurrentQuestionUrl: mock.fn()
 		};
 		const result = unitOptionEntryQuestion.formatAnswerForSummary('test', journey, 'ha');
@@ -99,6 +105,9 @@ describe('./src/dynamic-forms/components/unit-option-entry/question.js', () => {
 					[CONDITIONAL_FIELDNAME]: 'hello'
 				}
 			},
+			responseForSection() {
+				return this.response;
+			},
 			getCurrentQuestionUrl: mock.fn()
 		};
 		assert.throws(() => {

package/src/controller.d.ts

@@ -20,6 +20,9 @@ export function question(req: import("express-serve-static-core").Request<import
  * @property {boolean} isManageListItem
  * @property {string} [manageListQuestionFieldName]
  * @property {boolean} [manageListItemRemove]
+ * @property {boolean} isDynamicSection is this save action for a question within a DynamicSection?
+ * @property {string} [dynamicSectionId] if this is within a DynamicSection, what is the section ID (segment)
+ * @property {string} [dynamicSectionFieldName] if this is within a DynamicSection, what is the fieldName for the array?
  * @property {Object<string, any>} data
  */
 /**
@@ -31,9 +34,6 @@ export function question(req: import("express-serve-static-core").Request<import
  * @returns {import('express').Handler}
  */
 export function buildSave(saveData: SaveDataFn, redirectToTaskListOnSuccess?: boolean): import("express").Handler;
-export type Journey = import("./journey/journey.js").Journey;
-export type Question = import("./questions/question.js").Question;
-export type Section = import("./section.js").Section;
 export type SectionView = {
     heading: string;
     status: string;
@@ -62,6 +62,18 @@ export type SaveParams = {
     isManageListItem: boolean;
     manageListQuestionFieldName?: string | undefined;
     manageListItemRemove?: boolean | undefined;
+    /**
+     * is this save action for a question within a DynamicSection?
+     */
+    isDynamicSection: boolean;
+    /**
+     * if this is within a DynamicSection, what is the section ID (segment)
+     */
+    dynamicSectionId?: string | undefined;
+    /**
+     * if this is within a DynamicSection, what is the fieldName for the array?
+     */
+    dynamicSectionFieldName?: string | undefined;
     data: {
         [x: string]: any;
     };

package/src/controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["controller.js"],"names":[],"mappings":"AA+DA;;;GAGG;AACH,qCAHW,MAAM,GACJ,OAAO,SAAS,EAAE,OAAO,CAIrC;AAED;;;;;GAKG;AACH,0BALW,OAAO,SAAS,EAAE,OAAO,OACzB,OAAO,SAAS,EAAE,QAAQ,eAC1B,MAAM,YACN,MAAM,iBA8DhB;;AAmDD;;;;;;;;;;GAUG;AAEH;;GAEG;AAEH;;;;GAIG;AACH,oCAJW,UAAU,gCACV,OAAO,GACL,OAAO,SAAS,EAAE,OAAO,CAsFrC;sBA7RY,OAAO,sBAAsB,EAAE,OAAO;uBACtC,OAAO,yBAAyB,EAAE,QAAQ;sBAC1C,OAAO,cAAc,EAAE,OAAO;;aAK7B,MAAM;YACN,MAAM;UAEjB;QAAiC,IAAI,EAA1B,KAAK,CAAE,OAAO,CAAC;KAC5B;;;SAIa;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;WAChB;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;eAC1B,OAAO,+BAA+B,EAAE,UAAU,EAAE;;;;SAqK7D,OAAO,SAAS,EAAE,OAAO;SACzB,OAAO,SAAS,EAAE,QAAQ;eAC1B,MAAM;iBACN,MAAM;sBACN,OAAO;;;;;;;yBAOR,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC"}
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["controller.js"],"names":[],"mappings":"AAyDA;;;GAGG;AACH,qCAHW,MAAM,GACJ,OAAO,SAAS,EAAE,OAAO,CAIrC;AAED;;;;;GAKG;AACH,0BALW,OAAO,SAAS,EAAE,OAAO,OACzB,OAAO,SAAS,EAAE,QAAQ,eAC1B,MAAM,YACN,MAAM,iBAmEhB;;AAmDD;;;;;;;;;;;;;GAaG;AAEH;;GAEG;AAEH;;;;GAIG;AACH,oCAJW,UAAU,gCACV,OAAO,GACL,OAAO,SAAS,EAAE,OAAO,CA4FrC;;aApSa,MAAM;YACN,MAAM;UAEjB;QAAiC,IAAI,EAA1B,KAAK,CAAE,OAAO,CAAC;KAC5B;;;SAIa;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;WAChB;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;;eAC1B,OAAO,+BAA+B,EAAE,UAAU,EAAE;;;;SA0K7D,OAAO,SAAS,EAAE,OAAO;SACzB,OAAO,SAAS,EAAE,QAAQ;eAC1B,MAAM;iBACN,MAAM;sBACN,OAAO;;;;;;sBAGP,OAAO;;;;;;;;;;;;;yBAOR,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC"}

package/src/controller.js

@@ -1,16 +1,10 @@
 import { SECTION_STATUS } from './section.js';
 import questionUtils from './components/utils/question-utils.js';
-import { answerObjectForManageListSaving } from '#src/components/manage-list/utils.js';
+import { answerObjectForListItemSaving } from '#src/lib/answer-utils.js';
 import { booleanToYesNoValue } from '#src/components/boolean/question.js';
 import { MANAGE_LIST_ACTIONS } from '#src/components/manage-list/manage-list-actions.js';
 import { toArray } from '#src/lib/utils.js';
 
-/**
- * @typedef {import('./journey/journey.js').Journey} Journey
- * @typedef {import('./questions/question.js').Question} Question
- * @typedef {import('./section.js').Section} Section
- */
-
 /**
  * @typedef {Object} SectionView
  * @property {string} heading
@@ -77,7 +71,7 @@ export function buildList(viewData = {}) {
  */
 export async function list(req, res, pageCaption, viewData) {
 	//render check your answers view
-	/** @type {Journey} */
+	/** @type {import('./journey/journey.js').Journey} */
 	const journey = res.locals.journey;
 	/** @type {import("./journey/journey-response.js").JourneyResponse} */
 	const journeyResponse = res.locals.journeyResponse;
@@ -92,6 +86,9 @@ export async function list(req, res, pageCaption, viewData) {
 		const status = section.getStatus(journeyResponse);
 		const sectionView = buildSectionViewModel(section.name, status);
 
+		// answers for this section may be within an array, for example dynamic sections
+		const response = section.getResponse(journeyResponse);
+
 		// update completed count
 		if (status === SECTION_STATUS.COMPLETE) {
 			summaryListData.completedSectionCount++;
@@ -104,11 +101,13 @@ export async function list(req, res, pageCaption, viewData) {
 				continue;
 			}
 
-			if (!question.shouldDisplay(journeyResponse)) {
+			if (!question.shouldDisplay(response)) {
 				continue;
 			}
 
-			const answers = journey.response?.answers;
+			// answers here may be from an array for dynamic sections
+			// this is handled by section.responseForSection above
+			const answers = response.answers;
 			let answer = answers[question.fieldName];
 			const conditionalAnswer = questionUtils.getConditionalAnswer(answers, question, answer);
 			if (conditionalAnswer) {
@@ -195,6 +194,9 @@ export async function question(req, res) {
  * @property {boolean} isManageListItem
  * @property {string} [manageListQuestionFieldName]
  * @property {boolean} [manageListItemRemove]
+ * @property {boolean} isDynamicSection is this save action for a question within a DynamicSection?
+ * @property {string} [dynamicSectionId] if this is within a DynamicSection, what is the section ID (segment)
+ * @property {string} [dynamicSectionFieldName] if this is within a DynamicSection, what is the fieldName for the array?
  * @property {Object<string, any>} data
  */
 
@@ -229,6 +231,7 @@ export function buildSave(saveData, redirectToTaskListOnSuccess) {
 				return res.redirect(journey.taskListUrl);
 			}
 		}
+		const isDynamicSection = section.isDynamicSection;
 
 		try {
 			// check for validation errors
@@ -248,6 +251,9 @@ export function buildSave(saveData, redirectToTaskListOnSuccess) {
 				isManageListItem: question.isInManageListSection,
 				manageListQuestionFieldName: manageListQuestion?.fieldName,
 				manageListItemRemove: req.params?.manageListAction === MANAGE_LIST_ACTIONS.REMOVE,
+				isDynamicSection,
+				dynamicSectionId: isDynamicSection ? section.segment : undefined,
+				dynamicSectionFieldName: isDynamicSection ? section.fieldName : undefined,
 				data
 			});
 
@@ -264,7 +270,9 @@ export function buildSave(saveData, redirectToTaskListOnSuccess) {
 			// as question.shouldDisplay checks the response and is used to determine the next question
 			let answers = journeyResponse.answers;
 			if (question.isInManageListSection) {
-				answers = answerObjectForManageListSaving(journeyResponse, manageListQuestion, req.params);
+				answers = answerObjectForListItemSaving(journeyResponse, manageListQuestion, req.params.manageListItemId);
+			} else if (isDynamicSection) {
+				answers = answerObjectForListItemSaving(journeyResponse, section, section.segment);
 			}
 			for (const [k, v] of Object.entries(data?.answers || {})) {
 				if (typeof v === 'boolean') {